IBM Cloud API Docs

Introduction

Last updated: 2024-04-16

With the IBM Cloud® Virtual Private Cloud (VPC) API, you can programmatically provision and manage resources that are part of the IBM VPC Infrastructure as a Service (IaaS) across compute, storage, and networking. For more information on the IBM Cloud® Virtual Private Cloud and VPC resources, see Getting started with Virtual Private Cloud (VPC).

SDKs for Java, Node, Python, and Go are available to make it easier to programmatically access the API from your code. The client libraries that are provided by the SDKs implement best practices for using the API and reduce the amount of code that you need to write. The tab for each language includes code examples that demonstrate how to use the client libraries.

To learn about using IBM Cloud® Virtual Private Cloud, see:

This documentation describes the Go SDK version 0.50.0. This SDK uses Semantic Versioning, and as such, there may be backward-incompatible changes for any new 0.y.z version. For information about the latest Go SDK, see Releases. For instructions and examples on using IBM Cloud services in an IBM Cloud SDK client library, see Using the SDK.

This documentation describes the Java SDK version 0.18.0. This SDK uses Semantic Versioning, and as such, there may be backward-incompatible changes for any new 0.y.z version. For information about the latest Java SDK, see Releases. For instructions and examples on using IBM Cloud services in an IBM Cloud SDK client library, see Using the SDK.

This documentation describes the Node SDK version 0.19.0. This SDK uses Semantic Versioning, and as such, there may be backward-incompatible changes for any new 0.y.z version. For information about the latest Node SDK, see Releases. For instructions and examples on using IBM Cloud services in an IBM Cloud SDK client library, see Using the SDK.

This documentation describes the Python SDK version 0.21.0. This SDK uses Semantic Versioning, and as such, there may be backward-incompatible changes for any new 0.y.z version. For information about the latest Python SDK, see Releases. For instructions and examples on using IBM Cloud services in an IBM Cloud SDK client library, see Using the SDK.

The code examples on this tab use the client library that is provided for Go.

Installation:

go get github.com/IBM/vpc-go-sdk@v0.50.0

For more information, view the project on GitHub: https://github.com/IBM/vpc-go-sdk/. See also Using the SDK.

The code examples on this tab use the client library that is provided for Java.

Maven example:

<dependency>
    <groupId>com.ibm.cloud</groupId>
    <artifactId>vpc</artifactId>
    <version>0.18.0</version>
</dependency>

Gradle example:

compile 'com.ibm.cloud:vpc:0.18.0'

For more information, view the project on GitHub: https://github.com/IBM/vpc-java-sdk/. See also Using the SDK.

The code examples on this tab use the client library that is provided for Node.

Installation:

npm install ibm-vpc

For more information, view the project on GitHub: https://github.com/IBM/vpc-node-sdk/. See also Using the SDK.

The code examples on this tab use the client library that is provided for Python.

Installation:

pip install --upgrade "ibm-vpc>=0.21.0"

For more information, view the project on GitHub: https://github.com/IBM/vpc-python-sdk/. See also the Python client library for IBM Cloud VPC Services https://pypi.org/project/ibm-vpc/ and Using the SDK.

Endpoint URLs

The IBM Cloud VPC API is available in the following IBM Cloud® regions:

Location Region Endpoint (service URL)
Washington DC us-east https://us-east.iaas.cloud.ibm.com/v1
Dallas us-south https://us-south.iaas.cloud.ibm.com/v1
Toronto ca-tor https://ca-tor.iaas.cloud.ibm.com/v1
São Paulo br-sao https://br-sao.iaas.cloud.ibm.com/v1
Frankfurt eu-de https://eu-de.iaas.cloud.ibm.com/v1
Madrid eu-es https://eu-es.iaas.cloud.ibm.com/v1
London eu-gb https://eu-gb.iaas.cloud.ibm.com/v1
Sydney au-syd https://au-syd.iaas.cloud.ibm.com/v1
Osaka jp-osa https://jp-osa.iaas.cloud.ibm.com/v1
Tokyo jp-tok https://jp-tok.iaas.cloud.ibm.com/v1

To call the API, select the service URL that corresponds to the region of your choice and add a method path to form the complete request URL. For example, to list all images available in the us-south region, make a GET request to https://us-south.iaas.cloud.ibm.com/v1/images.

To change the SDK service URL, reinstantiate the service instance with a different region-specific URL. For more information, see Using the SDK.

Example request to call the us-south service URL:

curl -H "Authorization: Bearer {token}" -X {http_method} "https://us-south.iaas.cloud.ibm.com/v1{path}"

Replace {token}, {http_method}, and {path} in this example with the values for your particular request.

Default service URL:

https://us-south.iaas.cloud.ibm.com/v1

Example to change the service URL to the United Kingdom region:

authenticator := &core.IamAuthenticator{
  ApiKey: "{api_key}",
}

options := &vpcv1.VpcV1Options{
  Authenticator: authenticator,
  URL:  "https://eu-gb.iaas.cloud.ibm.com/v1",
}

For more information, see Using the SDK.

Default service URL:

https://us-south.iaas.cloud.ibm.com/v1

Example to change the service URL to the United Kingdom region:

Authenticator authenticator = new IamAuthenticator("{api_key}");
Vpc service = new Vpc("{version}", Vpc.DEFAULT_SERVICE_NAME, authenticator);
setServiceUrl("https://eu-gb.iaas.cloud.ibm.com/v1");

For more information, see Using the SDK.

Default service URL:

https://us-south.iaas.cloud.ibm.com/v1

Example to change the service URL to the United Kingdom region:

const service = {
  authenticator: new IamAuthenticator({
    apikey: '{api_key}'
  }),
  serviceUrl: 'https://eu-gb.iaas.cloud.ibm.com/v1'
};
const vpcService = new VpcV1(service);

For more information, see Using the SDK.

Default service URL:

https://us-south.iaas.cloud.ibm.com/v1

Example to change the service URL to the United Kingdom region:

from ibm_vpc import VpcV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

authenticator = IAMAuthenticator('apikey')
service = VpcV1(authenticator=authenticator)
service.set_service_url('https://eu-gb.iaas.cloud.ibm.com/v1')

For more information, see Using the SDK.

Authentication

The IBM Cloud VPC API uses Identity and Access Management (IAM) to authenticate requests. To call each API method, you must be assigned a role that includes the required IAM actions. Each method has an Authorization section that lists the required actions and, if applicable, the conditions under which each action is required. Check your access on the IBM Cloud console by navigating to Users > User > Access.

For more information about IAM actions and how they map to roles, see Assigning access to account management services and Managing IAM access for VPC Infrastructure Services.

Learn about obtaining an IAM token for an authenticated user or service ID in the IAM Identity Services API. If you first create an API key, you can use it to generate an IAM token.

To use the API, add a valid IAM token to the HTTP Authorization request header. For example, -H 'Authorization: Bearer {token}'.

When you use the SDK, configure an IAM authenticator with the IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can construct an authenticator in either of two ways:

  • Programmatically, by constructing an IAM authenticator instance and supplying your IAM API key.
  • Externally, in configuration options that are then used by the SDK to construct an IAM authenticator at run time.

Provide external configuration options by either:

  • Storing the configuration options in environment variables. When you initialize the service client, the SDK constructs the authenticator by reading the configuration properties directly from the environment variables.
  • Saving the configuration options in a file. When you initialize the service client, the SDK constructs the authenticator by reading the configuration properties from the file specified by the IBM_CREDENTIALS_FILE environment variable.

In this example of using external configuration properties, an IAM authenticator instance is created with the configured API key, and then the service client is constructed with this authenticator instance and the configured service URL.

For more information, see the Authentication section in the IBM Cloud SDK Common documentation.

Outside of development and testing, never hard-code secrets (such as IAM API keys) into a client application.

To retrieve your access token:

curl -X POST   "https://iam.cloud.ibm.com/identity/token"   --header 'Content-Type: application/x-www-form-urlencoded'   --header 'Accept: application/json'   --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey'   --data-urlencode 'apikey={api_key}'

To use the API, replace {token} with the token obtained above from IAM, replace {http_method} with an HTTP method such as POST, and replace {url} with a request URL such as https://us-south.iaas.cloud.ibm.com/v1/keys:

curl -H "Authorization: Bearer {token}" -X {http_method} "{url}"

Setting client options programmatically

Construct the service client programmatically, where {api_key} is your hardcoded IAM API key:

import {
  "github.com/IBM/go-sdk-core/v5/core"
  "github.com/IBM/vpc-go-sdk/vpcv1"
}
// Create an IAM authenticator.
authenticator := &core.IamAuthenticator{
  ApiKey: "{api_key}",
}
// Construct an "options" struct for creating the service client.
options := &vpcv1.VpcV1Options{
  Authenticator: authenticator,                            // required
  URL:           "https://us-east.iaas.cloud.ibm.com/v1",  // optional
}
// Construct the service client.
vpcService, err := vpcv1.NewVpcV1(options)
if err != nil {
  panic(err)
}

Service operations can now be invoked using the vpcService variable.

Setting client options through environment variables

Export environment variables to implement service client options, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

export VPC_URL={service_url}
export VPC_AUTH_TYPE=iam
export VPC_APIKEY={api_key}

Construct the service client using external configuration. vpcv1.NewVpcV1UsingExternalConfig() initializes the client with the environment variables, using them for subsequent authentication.

vpcService, err := vpcv1.NewVpcV1UsingExternalConfig()

Setting client options through a credentials file

Store credentials in a file such as my-credentials.env, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

VPC_URL={service_url}
VPC_AUTH_TYPE=iam
VPC_APIKEY={api_key}

Export the name of the file with an environment variable, where {credential_file_path} is the absolute path to your credentials file, such as "$HOME/secrets/vpc-credentials.env".

export IBM_CREDENTIALS_FILE={credential_file_path}

Construct the service client using external configuration. vpcv1.NewVpcV1UsingExternalConfig() initializes with the defined credential file, using it for subsequent authentication.

vpcService, err := vpcv1.NewVpcV1UsingExternalConfig()

Setting client options programmatically

Construct the service client programmatically, where {api_key} is your hardcoded IAM API key.

import com.ibm.cloud.is.vpc.v1.Vpc;
import com.ibm.cloud.sdk.core.security.Authenticator;
import com.ibm.cloud.sdk.core.security.IamAuthenticator;
// Create an IAM authenticator.
Authenticator authenticator = new IamAuthenticator.Builder()
  .apikey("{api_key}")
  .build();
// Construct the service client.
Vpc service = new Vpc(Vpc.DEFAULT_SERVICE_NAME, authenticator);
// Set our custom service URL (optional).
service.setServiceUrl("https://us-east.iaas.cloud.ibm.com/v1");

Setting client options through environment variables

Export environment variables to implement service client options, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

export VPC_URL={service_url}
export VPC_AUTH_TYPE=iam
export VPC_APIKEY={api_key}

Construct the service client using external configuration. Vpc.newInstance() initializes the client with the environment variables, using them for subsequent authentication.

import com.ibm.cloud.is.vpc.v1.Vpc;
Vpc service = Vpc.newInstance();

Setting client options through a credentials file

Store credentials in a file such as my-credentials.env, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

VPC_URL={service_url}
VPC_AUTH_TYPE=iam
VPC_APIKEY={api_key}

Export the name of the file with an environment variable, where {credential_file_path} is the absolute path to your credentials file, such as "$HOME/secrets/vpc-credentials.env".

export IBM_CREDENTIALS_FILE={credential_file_path}

Construct the service client using external configuration. Vpc.newInstance() initializes with the defined credential file, using it for subsequent authentication.

import com.ibm.cloud.is.vpc.v1.Vpc;
Vpc service = Vpc.newInstance();

Setting client options programmatically

Construct the service client programmatically, where {api_key} is your hardcoded IAM API key.

const VpcV1 = require('vpc-node-sdk/vpc/v1');
const { IamAuthenticator } = require('vpc-node-sdk/auth');

// Create an IAM authenticator.
const authenticator = new IamAuthenticator({
  apikey: '{api_key}',
});

// Construct the service client.
const vpcService = new VpcV1({
  authenticator,                                       // required
  serviceUrl: 'https://us-east.iaas.cloud.ibm.com/v1', // optional
});

Setting client options through environment variables

Export environment variables to implement service client options, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

export VPC_URL={service_url}
export VPC_AUTH_TYPE=iam
export VPC_APIKEY={api_key}

Construct the service client using external configuration. VpcV1.newInstance() initializes the client with the environment variables, using them for subsequent authentication.

const VpcV1 = require('vpc-node-sdk/vpc/v1');
const vpcService = VpcV1.newInstance();

Setting client options through a credentials file

Store credentials in a file such as my-credentials.env, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

VPC_URL={service_url}
VPC_AUTH_TYPE=iam
VPC_APIKEY={api_key}

Export the name of the file with an environment variable, where {credential_file_path} is the absolute path to your credentials file, such as "$HOME/secrets/vpc-credentials.env".

export IBM_CREDENTIALS_FILE={credential_file_path}

Construct the service client using external configuration. VpcV1.newInstance() initializes with the defined credential file, using it for subsequent authentication.

const VpcV1 = require('vpc-node-sdk/vpc/v1');
const vpcService = VpcV1.newInstance();

Setting client options programmatically

Construct the service client, where {api_key} is your hardcoded IAM API key

from ibm_vpc import VpcV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

# Create an IAM authenticator.
authenticator = IAMAuthenticator('{api_key}')
# Construct the service client.
service = VpcV1(authenticator=authenticator)
# Set custom service URL (optional)
service.set_service_url('https://us-east.iaas.cloud.ibm.com/v1')

Setting client options through environment variables

Export environment variables to implement service client options, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

export VPC_URL={service_url}
export VPC_AUTH_TYPE=iam
export VPC_APIKEY={api_key}

Construct the service client using external configuration. VpcV1.new_instance() initializes the client with the environment variables, using them for subsequent authentication.

from ibm_vpc import VpcV1
service = VpcV1.new_instance()

Setting client options through a credentials file

Store credentials in a file such as my-credentials.env, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

VPC_URL={service_url}
VPC_AUTH_TYPE=iam
VPC_APIKEY={api_key}

Export the name of the file with an environment variable, where {credential_file_path} is the absolute path to your credentials file, such as "$HOME/secrets/vpc-credentials.env".

export IBM_CREDENTIALS_FILE={credential_file_path}

Construct the service client using external configuration. VpcV1.new_instance() initializes with the defined credential file, using it for subsequent authentication.

from ibm_vpc import VpcV1
service = VpcV1.new_instance()

Authorization

Access to VPC infrastructure resources is managed through IAM. IAM provides the ability to manage resources through resource groups and access management tags. For more information, see Managing IAM access for VPC Infrastructure Services.

Auditing

Monitor API activity within your account by using the IBM Cloud Activity Tracker service. Each time you make an API call, one or more events are generated that you can track and audit from within Activity Tracker. Specific auditing event types are listed for each individual method. For more information about how to track VPC activity, see Activity Tracker events.

Error handling

This API uses standard HTTP response codes to indicate the outcome of a request. A 4xx-series response indicates a failure that the client must resolve. A 5xx-series response indicates a service failure.

HTTP Error Code Description Recovery
400 Bad Request The input parameters in the request body are either incomplete, malformed, or too large. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. Log in to IBM Cloud and try submitting the request again. If this error persists, contact the account owner to check your permissions.
403 Forbidden The supplied authentication is not authorized to perform the requested operation. Either you do not have valid access through IAM access policies or your request is denied due to the context-based restriction policy. If this error persists, contact the account owner to check your permissions.
404 Not Found The requested resource could not be found but may be available in the future.
405 Method Not Allowed The requested resource does not support the request method.
406 Not Acceptable The resource the client requested is not available in a format allowed by the Accept header supplied by the client.
408 Request Timeout The connection to the server timed out. Wait a few minutes, and try submitting the request again.
409 Conflict The request cannot be completed because of a conflict between the request and the current state of the resource.
412 Precondition Failed The client specified one or more preconditions in its headers, and the server cannot meet those preconditions.
426 Upgrade Required The server refuses to perform the request using the current protocol but might perform the request after the client upgrades to a different protocol.
500 Internal Server Error The request cannot be processed because the client encountered an unexpected condition on the server. Wait a few minutes and try submitting the request again. If this error persists, contact IBM Support.
501 Not Implemented The server either does not recognize the request method, or it lacks the ability to fulfill the request.
502 Bad Gateway The server was acting as a gateway or proxy and received an invalid response from the upstream server.
503 Service Unavailable The server cannot process the request. Generally, this condition is temporary, such as when a server is overloaded or down for scheduled maintenance. This condition could also be due to an unplanned outage of a service that is needed to process the request. Wait a few minutes and try submitting the request again. If this error persists, contact IBM Support.
504 Gateway Timeout The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
505 HTTP Version Not Supported The server does not support the HTTP protocol version that is used in the request.

Error handling example:

import "github.com/IBM/vpc-go-sdk/vpcv1"

// Instantiate a service
vpcService, vpcServiceErr := vpcv1.NewVpcV1(options)

// Check for errors
if vpcServiceErr != nil {
  panic(vpcServiceErr)
}

// Call a method
listVpcsOptions := &vpcv1.ListVpcsOptions{}
  vpcs, _, err := vpcService.ListVpcs(listVpcsOptions)

// Check for errors
if err != nil {
  panic(err)
}

Error handling example:

try {
  // Invoke an operation
  Response<Resource> response = service.getResource(options).execute();


  // Process response...


} catch (BadRequestException e) {
  // Handle Bad Request (400) exception
} catch (UnauthorizedException e) {
  // Handle Unauthorized (401) exception
} catch (NotFoundException e) {
  // Handle Not Found (404) exception
} catch (RequestTooLargeException e) {
  // Handle Request Too Large (413) exception
} catch (ServiceResponseException e) {
  // Base class for all exceptions caused by error responses from the service
  System.out.println("Service returned status code "
    + e.getStatusCode() + ": " + e.getMessage());
  System.out.println("Detailed error info:\n" + e.getDebuggingInfo().toString());
}

Error handling example:

try {
    const response = await vpcService.getResource();
    // ...handle successful response...
} catch (err) {
    // ...handle error response...
    console.log("Error status code: " + err.status + " (" + err.statusText + ")");
    console.log("Error message:     " + err.message);
}

Example of error handling:

from ibm_cloud_sdk_core import ApiException

try:
    vpcs = service.list_vpcs().get_result()['vpcs']
except ApiException as e:
    print("List VPC failed with status code " + str(e.code) + ": " + e.message)

Versioning

This reference documents API behavior for any date value in the version parameter between 2022-10-10 and today's date. To view the reference for an older version of the API, select it from the Version list.

Requests to the VPC API require a major version as the first segment of the request path (/v1/) and a date-based version as a query parameter in the format version=YYYY-MM-DD.

The VPC API supports a continuous series of version dates from 2019-01-01 to today's date (in UTC).

Most changes to the VPC API are designed to be compatible with existing clients and are made available to clients that specify any supported version date. For example, support for new paths, new optional parameters, and additional properties in responses are considered backward compatible and, when possible, are made available without respect to the version date specified by a client.

By design, backward-incompatible changes, such as the removal or restructuring of existing properties or parameters, are made available only for clients that specify version dates on or after the feature became available.

To maximize the compatibility of your client with future API changes, follow the best practices for client development.

When you develop a new client, specify the current date (as of the time of development) as a fixed value for the version parameter, and keep that same fixed version date value when you test and ship your client. Do not specify a value for the version parameter that is dynamically computed based on the date your code is compiled or executed.

Features that require clients to specify a later version date are specifically noted in the change log, along with guidance on how to migrate your client to work with newer versions.

As a best practice, review the change log on a periodic basis. To use the latest features and maintain ongoing compatibility, update and test your client with a newer version date. As with new clients, specify the current date (as of the time you update your client code) as a fixed value for the version parameter.

Deprecation

A method, path, parameter, property or other feature will be marked as deprecated when usage is no longer recommended, such as when it's been rendered obsolete by new features. After a feature is deprecated, support for that feature may be removed for clients that specify new version dates.

Features that are no longer supported in new API versions are specifically noted in the change log, along with guidance on how to migrate your client to work with newer versions.

The oldest supported version date (currently 2019-01-01) may be moved forward in the future, necessitating clients to specify a newer version date and make any updates needed to work with that newer version.

Each SDK version uses a corresponding version of the API that it was developed and tested to be compatible with.

Example request to list regions in the 2024-04-16 version of the v1 API:

curl -X GET   "$vpc_api_endpoint/v1/regions?version=2024-04-16&generation=2"   -H "Authorization: Bearer $iam_token"

Property value expansion

Unless explicitly stated otherwise, relaxing constraints for a property's values is considered a backward-compatible change that is expected to occur to accommodate new features or products. Backward-compatible property value expansion supports the following:

  • For numeric properties: increasing maximum values or decreasing minimum values
  • For array properties: increasing maximum item counts or decreasing minimum item counts
  • For string properties: increasing maximum lengths or decreasing minimum lengths
  • For enumerations: expanding the set of enumerated values
  • For One of: adding choices to an existing One of selection

For example, the maximum value for the Share iops property in the specification reflects the current maximum IOPS that can be supported by the IBM Cloud VPC File Storage service. However, the value in the specification may be subsequently increased, even for existing API versions. Likewise, the values for enumerations, such as the Share access_control_mode, encryption, and replication_status properties may be subsequently expanded, even for existing API versions. Additionally, a set of One of choices, such as adding another choice for security group targets, may be expanded in the future for existing API versions.

To maximize the compatibility of your client with future API changes, follow the best practices for client development.

Concurrent update protection

To prevent multiple clients from unknowingly overwriting each other's updates, select API methods support entity-tags and conditional requests as specified in RFC 7232.

To make a conditional request, first issue a GET request on the resource to retrieve its up-to-date representation. The response will include an ETag header, whose value is a fingerprint of the resource's current client-configurable state. Next, verify that the method you want to perform (typically an update or a delete) is appropriate given the current state of the resource. For example, you may want to only delete a VPN server if its port property has a specific value. Finally, if the resource is still in the appropriate state, issue the API request, as usual, but make the request conditional by including an If-Match header with its value set to the ETag value from the earlier GET request.

Because the If-Match header was provided, the server will check that the resource's current ETag value (which reflects the client-configurable state) matches the value you provided in the If-Match header. If the two values match, the server can be certain the resource has not been updated in the interim, and request processing continues as usual. Otherwise, the resource was updated (by another client) between the time you issued the GET and the time you issued the conditional request, and the request will fail with 412 Precondition Failed. Because a resource may be updated by another client at any time, clients issuing conditional requests must be written to check for a 412 failure, and if encountered, restart the sequence by reissuing the original GET request.

Because 412 indicates that the resource has been updated, before reissuing the conditional request, the client must both retrieve the latest ETag value using GET and verify that the representation of the resource is still appropriate for the conditional request.

For additional safety, the VPC API requires that any PATCH request that includes an array property must also provide an If-Match header. For example, a PATCH /volumes/{id} request that includes the user_tags array property will fail with 400 Bad Request if the If-Match header is not provided. In contrast, a PATCH /volumes/{id} request to modify just the name string property need not provide an If-Match header (since no array is present). However, if the If-Match header is provided, the server will check its value and will return 412 Precondition Failed if the value is not current.

The ETag and If-Match headers must be used only on methods that have explicit documentation that those headers are supported. Other related headers described in RFC 7232, such as If-None-Match and If-Modified-Since, are not supported at this time.

Maturity query parameter

API requests accept a maturity query parameter. This parameter lets you decide on the level of stability to use before features become generally available.

For the API behavior documented in this reference, omit the maturity query parameter. For information on making beta requests, see the Beta VPC API reference.

Pagination

Some API requests can return many results. To improve performance, results are returned one page at a time, with a limited number of results on each page. The default page size is typically 50 items, with a maximum size of 100.

The default and maximum limits might vary by operation. To specify a different page size, use the limit query parameter.

For a request that uses pagination, the response includes additional properties:

  • The first.href property links to the first page of resources
  • The next.href property links to the next page of resources (included for all pages except for the last page)

Use query parameters to page through your available resources and retrieve a subset of objects. To retrieve the first page of results, make the request without specifying a start query parameter. If the results cannot fit on the first page, the response will include a next property, whose value can then be specified as the start parameter when making the next page request. Each page of results is based on the resources that exist at the time of each paginated request, and therefore may include resources that did not exist when the first request was made. The last page of results will not include a next property.

When you're retrieving a subset of objects:

  • You must add the version and generation query parameters to the href value before you make the request
  • You may use the value of first.href to retrieve the first page of resources in the requested sort order and with the requested filters
  • You may use the value of next.href to retrieve the next page of resources in the requested sort order and with the requested filters
  • You may not change the requested filters across page retrievals
  • You may not add a sort query parameter to the href value (sort order is set by the first paginated list request)
  • You may modify the limit in the href value to limit the number of resources to return, per page, in a paginated list operation
  • You may not change the path segments of the request (that is, anything before the ? in the href value)

List the first five keys: .../keys?limit=5

List the first five keys on the next page: .../keys?limit=5&start=9d5a91a3e2cbd233b5a5b33436855ed1

The next value comes from the previous response's start value, which is a link. Here's the href from the response of the first page:

"href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs?limit=1&start=r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217"

Use the start value r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217 in your next call to fetch page 2:

next := "r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217"
	listVpcsOptions := &vpcv1.ListVpcsOptions{
		Limit: core.Int64Ptr(1),
		Start: &next,
	}
	vpcs, _, err := vpcService.ListVpcs(listVpcsOptions)

The next value comes from the previous response's start value, which is a link. Here's the href from the response of the first page:

"href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs?limit=1&start=r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217"

Use the start value r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217 in your next call to fetch page 2:

ListVpcsOptions listVpcsOptions = new ListVpcsOptions.Builder()
.start("r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217")
.limit(Long.valueOf("10"))
.build();
Response<VPCCollection> response = service.listVpcs(listVpcsOptions).execute();
VPCCollection vpcCollectionResult = response.getResult();

The next value comes from the previous response's start value, which is a link. Here's the href from the response of the first page:

"href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs?limit=1&start=r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217"

Copy the start value r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217 to the clipboard, and use that value in your next call to fetch page 2:

      const listVpcsResult = vpcService.listVpcs({
          start: 'r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217',
          limit: 10,
        });

The next value comes from the previous response's start value, which is a link. Here's the href from the response of the first page:

"href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs?limit=1&start=r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217"

Use the start value r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217 in your next call to fetch page 2:

    next = response.get_result()['next']
try:
    response = service.list_vpcs(start="r134-fe06d70f-ec6c-4451-b0a2-37b6ec91a217", limit=1).get_result()['vpcs']
except ApiException as e:
    print("List VPC failed with status code " + str(e.code) + ": " + e.message)

Response model properties

Certain properties are included in API responses for all customer-created VPC resources. The created_at value is a timestamp that matches when the resource became visible through calls to the IBM Cloud VPC API.

Generation

To use the IBM Cloud VPC infrastructure, send the generation=2 query parameter with every API request.

Example: Create a VPC

POST /v1/vpcs?generation=2

Variables

Consider storing frequently used values (such as the API service URL, authorization token, API version, and other resource identifiers) in variables.

The following topics contain information on setting variables:

Example of storing the us-south service URL in a variable:

vpc_api_endpoint=https://us-south.iaas.cloud.ibm.com

Resources

The VPC API is structured around resources of various types, such as block storage volumes (called "volumes" in the API), and virtual server instances (called "instances" in the API). Each resource consists of a set of properties and supports a set of operations, such as updating some of its property values, or deleting the resource. Certain complex resources also have child resources. For example, the instance resource has one or more volume attachment child resources, with each volume attachment associating the instance with a volume it uses. As with other resources, child resources also have a set of properties and a set of operations, which can be performed on the child resource. Child resources can also have their own child resources.

There is a hierarchical relationship between a resource and its child resources, which is reflected in VPC's API path hierarchy. For example, the API path to retrieve a volume attachment is GET /instances/{instance_id}/volume_attachments/{id}, reflecting that every volume attachment has an instance as its parent resource. This hierarchy is also evident in their lifecycles: deleting an instance will delete all of its child resources, including all of its volume attachments.

Resources that appear in the first segment of the API path hierarchy, such as /instances in the previous example, are sometimes referred to as top-level resources. By convention, top-level resources in the VPC API have crn properties that provide the resource's global Cloud Resource Name (CRN). These CRNs enable top-level resources to be integrated with other IBM Cloud services, such as IAM, billing, and global tagging. For example, because volume attachments are a child resource and do not have their own CRNs, it is not possible to create an IAM policy for a specific volume attachment. Instead, the IAM policies for the parent instance's CRN control access to its volume attachments.

In many situations, the distinction between a top-level resource and a child resource is not important, and the term "resource" is often used to refer to either type of resource.

Resource modeling

Each resource type in the VPC API is represented by a handful of data models, which tailor the resource's properties to the operation being performed:

Prototype model
Used in the request body when creating a resource with POST.
Base model
Returned in the response body when retrieving a resource with GET. This model is also returned in the response body from many other operations, such as when creating a resource.
Patch model
Used in the request body when updating a resource with PATCH.
Identity model
Used when identifying a resource in a request body.
Reference model
Used when identifying a resource in a response body.

Models go hand in hand with objects. An object is an instantiation of a model. For example, POST /instances requires a request body that adheres to the InstancePrototype model, and that request body is an instance prototype object. The response body from POST /instances adheres to the Instance model, and that response body is an instance object. Likewise, the PATCH /instances/{id} request body is an InstancePatch object, and the response body is an Instance object.

In the VPC API, resources are often associated with other resources. When creating an association with a resource, that resource's identity model is used. For example, POST /instances/{id}/volume_attachments, which creates a new volume attachment, expects a VolumeAttachmentPrototype object. That object includes a volume property (VolumeIdentity model) that identifies the volume to attach. As a convenience, some resources have multiple ways to identify them, such as volume.crn, volume.id or volume.href in this scenario.

For an association to succeed, the caller's IAM policies must permit the caller to operate on the identified resource. Additionally, the identified resource must be in the caller's account unless a specific property documents an exception.

To ensure predictable behavior, mutable properties, such as a resource's mutable name, are never included in identity models.

When a resource is retrieved, its association with another resource is shown using that resource's reference model. Continuing the previous example, GET /instances/{instance_id}/volume_attachments/{id} returns a VolumeAttachment object, which includes a volume property (VolumeReference model). In addition to including the identifiers that were present in the VolumeIdentity model (volume.crn, volume.id, and volume.href), it also includes its volume.name, and an optional volume.deleted property, which indicates that the resource no longer exists.

Many reference models also include a resource_type property, which is essential in polymorphic contexts. For example, the floating IP resource (FloatingIP model) includes a target property, which is a oneOf that can refer to a NetworkInterfaceReference or a PublicGatewayReference depending on the way the floating IP resource was created. Further, new types of floating IP targets might be introduced in the future. A client that calls GET /floating_ips/{id} can check the value of target.resource_type to determine if target refers to a network interface resource, a public gateway resource, or another resource type that was introduced after the client was developed.

The properties in a resource's identity and reference models are not subject to that resource's IAM policies. For example, although the volume property included in the response from GET /instances/{instance_id}/volume_attachments/{id} included identifying information about the volume, such as its name and id, the caller did not need an IAM policy to read the volume. This design facilitates adhering to least privilege, because the caller can understand the associations a resource has with other resources without having to be granted access to see the specifics of the associated resources. However, because of this design, it's important to never place sensitive information in a resource's name.

Resource names

VPC resource names adhere to a common regular expression that:

  • Forbids uppercase characters
  • Forbids trailing dashes
  • Reserves leading dashes for system use
  • Has a name length of 1 - 63 characters
  • Allows leading digits for system-owned resources (and, eventually, for all resources)

    • On a request, the permitted regex is ^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$.

      Resources that do not yet allow leading digits use ^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$.

    • On a response, the possible regex is ^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$.

Resource namespaces are per resource type and per account. For example, a volume and a server in the same availability zone (AZ) and account can both be named b, and two accounts can both contain a volume that is named b in the same AZ.

For a resource type within an account:

  • If the resource is scoped within a parent resource, names must be unique within that parent resource.
  • If the resource is scoped within a VPC, names must be unique within that VPC.
  • If the resource is regional (or smaller), names must be regionally unique.

If a resource's namespace can contain both customer-created and IBM-created resources, all IBM-created resources (such as IBM-provided images) begin with ibm-. Customers are unable to create resources with the prefix ibm-.

Resource names that begin with a hyphen (-) are reserved for system use and are sometimes used in place of user-defined names. For example, names included with references to deleted resources are prefixed with -deleted-.

If you don't name a resource during resource creation, the system automatically generates a resource name.

Deleted resources

In some responses, embedded resource references may refer to resources that have been deleted. This possibility is noted in contexts where it's expected. Rarely, references to deleted resources may also appear when the system cannot resolve a conflict between concurrent requests.

The presence of a deleted property can be used to determine that a reference is to a deleted resource. The deleted property contains an object with a more_info link to relevant documentation.

As shown in the example, references to deleted resources will have a name prefixed with -deleted- and suffixed with a value to ensure the resource remains unique within its namespace, even if its user-defined name has been reused. This name should not be parsed for information and may not contain any part of the original user-defined name.

Deleted resource reference example:

{
  "name": "-deleted-e1b7144d1645",
  "href": "https://us-south.iaas.cloud.ibm.com/v1/volumes/b6b9395e-6a4d-4291-b824-e1b7144d1645",
  "crn": "crn:[...]",
  "deleted": {
    "more_info": "https://cloud.ibm.com/apidocs/vpc#deleted-resources"
  }
}

Remote resources

In some responses, embedded resource references may refer to resources that are in another region, in another account, or in both another region and another account. If a given reference can be remote, the specification will include a remote property, which can contain account and region child properties, which identify the remote account and remote region for the resource, respectively.

The remote reference shown in the example shows a source image that is both in a different account, and in a region (us-south) that is different from the region being called (us-east). Because the resource has no representation in the region being called, the href for the resource refers to its native region (us-south.iaas.cloud.ibm.com). In contrast, because the remote.region has a representation in the region being called, the remote.region.href refers to the called region (us-east.iaas.cloud.ibm.com).

When authoring clients that operate on remote references, bear the following in mind:

  • The resource may have the same name as another local resource, which it may have no relationship to.
  • Mutable information, such as its name and whether it has been deleted, may not be current.
  • The resource cannot be directly accessed and may not be accessible at all. For example, attempting to retrieve the example resource above using GET /v1/images/72b27b5c-f4b0-48bb-b954-5becc7c1dcb8 results in 404 because the resource is in another account. However, if the resource had been in the same account, but still in a different region, the GET method would result in a 301 Moved Permanently, allowing clients that support redirects to retrieve the resource from its native region.

As discussed in Resources, reference models are not subject to the resource's IAM policies. Therefore, even if the IAM policy that allowed the remote reference to be established is revoked, any remote references that were previously established may continue to have their name updated. Because of this design, it's important to never place sensitive information in a resource's name.

Remote resource reference example:

{
  "crn": "crn:v1:bluemix:public:is:us-south:a/02828f9c8fd74b73859d371a406af2a1::image:72b27b5c-f4b0-48bb-b954-5becc7c1dcb8",
  "id": "72b27b5c-f4b0-48bb-b954-5becc7c1dcb8",
  "href": "https://us-south.iaas.cloud.ibm.com/v1/images/72b27b5c-f4b0-48bb-b954-5becc7c1dcb8",
  "name": "my-image",
  "remote": {
    "account": {
      "id": "02828f9c8fd74b73859d371a406af2a1",
      "resource_type": "account"
    },
    "region": {
       "href": "https://us-east.iaas.cloud.ibm.com/v1/regions/us-south",
       "name": "us-south",
       "resource_type": "region"
    }
}

API best practices

To minimize bugs caused by changes, follow these best practices when making an API requests:

  • When processing values for properties that have been expanded, such as for numeric, array, string, and enumeration values, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected property value was encountered.
  • Catch and log any 4xx or 5xx HTTP status code along with the included trace property
  • Follow HTTP redirect rules for any 3xx HTTP status code.
  • Use only the resources and properties that are needed for your client to function.
  • Do not send any extraneous input in a request.
  • Specify a fixed value for the API version parameter
  • Avoid depending on any behavior that is not explicitly documented.

Change log

Important changes to the API, such as additions, updates, and deprecations, are documented in the change log.

Features that require clients to specify a later version date are specifically noted in the change log, along with guidance on how to migrate your client to work with newer versions. See Versioning for more information.

SDK changes are based on API changes. When a new API version is available, the SDK reflects changes in the API.

Related APIs

Beta Virtual Private Cloud API

Methods

List all VPCs

This request lists all VPCs in the region. A VPC is a virtual network that belongs to an account and provides logical isolation from other networks. A VPC is made up of resources in one or more zones. VPCs are regional, and each VPC can contain resources in multiple zones in a region.

This request lists all VPCs in the region. A VPC is a virtual network that belongs to an account and provides logical isolation from other networks. A VPC is made up of resources in one or more zones. VPCs are regional, and each VPC can contain resources in multiple zones in a region.

This request lists all VPCs in the region. A VPC is a virtual network that belongs to an account and provides logical isolation from other networks. A VPC is made up of resources in one or more zones. VPCs are regional, and each VPC can contain resources in multiple zones in a region.

This request lists all VPCs in the region. A VPC is a virtual network that belongs to an account and provides logical isolation from other networks. A VPC is made up of resources in one or more zones. VPCs are regional, and each VPC can contain resources in multiple zones in a region.

This request lists all VPCs in the region. A VPC is a virtual network that belongs to an account and provides logical isolation from other networks. A VPC is made up of resources in one or more zones. VPCs are regional, and each VPC can contain resources in multiple zones in a region.

GET /vpcs
(vpc *VpcV1) ListVpcs(listVpcsOptions *ListVpcsOptions) (result *VPCCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVpcsWithContext(ctx context.Context, listVpcsOptions *ListVpcsOptions) (result *VPCCollection, response *core.DetailedResponse, err error)
list_vpcs(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        classic_access: Optional[bool] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPCCollection> listVpcs(ListVpcsOptions listVpcsOptions)
listVpcs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.list

  • is.vpc.vpc.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.vpc.read

Create a VPC

This request creates a new VPC from a VPC prototype object. The prototype object is structured in the same way as a retrieved VPC, and contains the information necessary to create the new VPC.

This request creates a new VPC from a VPC prototype object. The prototype object is structured in the same way as a retrieved VPC, and contains the information necessary to create the new VPC.

This request creates a new VPC from a VPC prototype object. The prototype object is structured in the same way as a retrieved VPC, and contains the information necessary to create the new VPC.

This request creates a new VPC from a VPC prototype object. The prototype object is structured in the same way as a retrieved VPC, and contains the information necessary to create the new VPC.

This request creates a new VPC from a VPC prototype object. The prototype object is structured in the same way as a retrieved VPC, and contains the information necessary to create the new VPC.

POST /vpcs
(vpc *VpcV1) CreateVPC(createVPCOptions *CreateVPCOptions) (result *VPC, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPCWithContext(ctx context.Context, createVPCOptions *CreateVPCOptions) (result *VPC, response *core.DetailedResponse, err error)
create_vpc(
        self,
        *,
        address_prefix_management: Optional[str] = None,
        classic_access: Optional[bool] = None,
        dns: Optional['VPCDNSPrototype'] = None,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPC> createVpc(CreateVpcOptions createVpcOptions)
createVpc(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.create

Auditing

Calling this method generates the following auditing event.

  • is.vpc.vpc.create

Delete a VPC

This request deletes a VPC. This operation cannot be reversed.

For this request to succeed:

  • Instances, subnets, public gateways, and endpoint gateways must not reside in this VPC
  • The VPC must not be providing DNS resolution for any other VPCs
  • If dns.enable_hub is true, dns.resolution_binding_count must be zero

All security groups and network ACLs associated with the VPC are automatically deleted. All flow log collectors with auto_delete set to true targeting the VPC or any resource in the VPC are automatically deleted.

This request deletes a VPC. This operation cannot be reversed.

For this request to succeed:

  • Instances, subnets, public gateways, and endpoint gateways must not reside in this VPC
  • The VPC must not be providing DNS resolution for any other VPCs
  • If dns.enable_hub is true, dns.resolution_binding_count must be zero

All security groups and network ACLs associated with the VPC are automatically deleted. All flow log collectors with auto_delete set to true targeting the VPC or any resource in the VPC are automatically deleted.

This request deletes a VPC. This operation cannot be reversed.

For this request to succeed:

  • Instances, subnets, public gateways, and endpoint gateways must not reside in this VPC
  • The VPC must not be providing DNS resolution for any other VPCs
  • If dns.enable_hub is true, dns.resolution_binding_count must be zero

All security groups and network ACLs associated with the VPC are automatically deleted. All flow log collectors with auto_delete set to true targeting the VPC or any resource in the VPC are automatically deleted.

This request deletes a VPC. This operation cannot be reversed.

For this request to succeed:

  • Instances, subnets, public gateways, and endpoint gateways must not reside in this VPC
  • The VPC must not be providing DNS resolution for any other VPCs
  • If dns.enable_hub is true, dns.resolution_binding_count must be zero

All security groups and network ACLs associated with the VPC are automatically deleted. All flow log collectors with auto_delete set to true targeting the VPC or any resource in the VPC are automatically deleted.

This request deletes a VPC. This operation cannot be reversed.

For this request to succeed:

  • Instances, subnets, public gateways, and endpoint gateways must not reside in this VPC
  • The VPC must not be providing DNS resolution for any other VPCs
  • If dns.enable_hub is true, dns.resolution_binding_count must be zero

All security groups and network ACLs associated with the VPC are automatically deleted. All flow log collectors with auto_delete set to true targeting the VPC or any resource in the VPC are automatically deleted.

DELETE /vpcs/{id}
(vpc *VpcV1) DeleteVPC(deleteVPCOptions *DeleteVPCOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPCWithContext(ctx context.Context, deleteVPCOptions *DeleteVPCOptions) (response *core.DetailedResponse, err error)
delete_vpc(
        self,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpc(DeleteVpcOptions deleteVpcOptions)
deleteVpc(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.vpc.vpc.delete

  • is.flow-log-collector.flow-log-collector.delete

    Generated when a flow log collector that had auto_delete set to true was attached to the VPC

  • is.flow-log-collector.flow-log-collector.detach

    Generated when a flow log collector was attached to the VPC

  • is.vpc.vpc.detach

    Generated when the VPC had a flow log collector attached to it

Retrieve a VPC

This request retrieves a single VPC specified by the identifier in the URL.

This request retrieves a single VPC specified by the identifier in the URL.

This request retrieves a single VPC specified by the identifier in the URL.

This request retrieves a single VPC specified by the identifier in the URL.

This request retrieves a single VPC specified by the identifier in the URL.

GET /vpcs/{id}
(vpc *VpcV1) GetVPC(getVPCOptions *GetVPCOptions) (result *VPC, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCWithContext(ctx context.Context, getVPCOptions *GetVPCOptions) (result *VPC, response *core.DetailedResponse, err error)
get_vpc(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPC> getVpc(GetVpcOptions getVpcOptions)
getVpc(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.vpc.read

Update a VPC

This request updates a VPC with the information provided in a VPC patch object. The patch object is structured in the same way as a retrieved VPC and needs to contain only the information to be updated.

This request updates a VPC with the information provided in a VPC patch object. The patch object is structured in the same way as a retrieved VPC and needs to contain only the information to be updated.

This request updates a VPC with the information provided in a VPC patch object. The patch object is structured in the same way as a retrieved VPC and needs to contain only the information to be updated.

This request updates a VPC with the information provided in a VPC patch object. The patch object is structured in the same way as a retrieved VPC and needs to contain only the information to be updated.

This request updates a VPC with the information provided in a VPC patch object. The patch object is structured in the same way as a retrieved VPC and needs to contain only the information to be updated.

PATCH /vpcs/{id}
(vpc *VpcV1) UpdateVPC(updateVPCOptions *UpdateVPCOptions) (result *VPC, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPCWithContext(ctx context.Context, updateVPCOptions *UpdateVPCOptions) (result *VPC, response *core.DetailedResponse, err error)
update_vpc(
        self,
        id: str,
        vpc_patch: 'VPCPatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPC> updateVpc(UpdateVpcOptions updateVpcOptions)
updateVpc(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.update

Auditing

Calling this method generates the following auditing event.

  • is.vpc.vpc.update

Retrieve a VPC's default network ACL

This request retrieves the default network ACL for the VPC specified by the identifier in the URL. The default network ACL is applied to any new subnets in the VPC which do not specify a network ACL.

This request retrieves the default network ACL for the VPC specified by the identifier in the URL. The default network ACL is applied to any new subnets in the VPC which do not specify a network ACL.

This request retrieves the default network ACL for the VPC specified by the identifier in the URL. The default network ACL is applied to any new subnets in the VPC which do not specify a network ACL.

This request retrieves the default network ACL for the VPC specified by the identifier in the URL. The default network ACL is applied to any new subnets in the VPC which do not specify a network ACL.

This request retrieves the default network ACL for the VPC specified by the identifier in the URL. The default network ACL is applied to any new subnets in the VPC which do not specify a network ACL.

GET /vpcs/{id}/default_network_acl
(vpc *VpcV1) GetVPCDefaultNetworkACL(getVPCDefaultNetworkACLOptions *GetVPCDefaultNetworkACLOptions) (result *DefaultNetworkACL, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCDefaultNetworkACLWithContext(ctx context.Context, getVPCDefaultNetworkACLOptions *GetVPCDefaultNetworkACLOptions) (result *DefaultNetworkACL, response *core.DetailedResponse, err error)
get_vpc_default_network_acl(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DefaultNetworkACL> getVpcDefaultNetworkAcl(GetVpcDefaultNetworkAclOptions getVpcDefaultNetworkAclOptions)
getVpcDefaultNetworkAcl(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.read

Retrieve a VPC's default routing table

This request retrieves the default routing table for the VPC specified by the identifier in the URL. The default routing table is associated with any subnets in the VPC which have not been explicitly associated with another routing table.

This request retrieves the default routing table for the VPC specified by the identifier in the URL. The default routing table is associated with any subnets in the VPC which have not been explicitly associated with another routing table.

This request retrieves the default routing table for the VPC specified by the identifier in the URL. The default routing table is associated with any subnets in the VPC which have not been explicitly associated with another routing table.

This request retrieves the default routing table for the VPC specified by the identifier in the URL. The default routing table is associated with any subnets in the VPC which have not been explicitly associated with another routing table.

This request retrieves the default routing table for the VPC specified by the identifier in the URL. The default routing table is associated with any subnets in the VPC which have not been explicitly associated with another routing table.

GET /vpcs/{id}/default_routing_table
(vpc *VpcV1) GetVPCDefaultRoutingTable(getVPCDefaultRoutingTableOptions *GetVPCDefaultRoutingTableOptions) (result *DefaultRoutingTable, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCDefaultRoutingTableWithContext(ctx context.Context, getVPCDefaultRoutingTableOptions *GetVPCDefaultRoutingTableOptions) (result *DefaultRoutingTable, response *core.DetailedResponse, err error)
get_vpc_default_routing_table(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DefaultRoutingTable> getVpcDefaultRoutingTable(GetVpcDefaultRoutingTableOptions getVpcDefaultRoutingTableOptions)
getVpcDefaultRoutingTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table.read

Retrieve a VPC's default security group

This request retrieves the default security group for the VPC specified by the identifier in the URL. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.

This request retrieves the default security group for the VPC specified by the identifier in the URL. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.

This request retrieves the default security group for the VPC specified by the identifier in the URL. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.

This request retrieves the default security group for the VPC specified by the identifier in the URL. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.

This request retrieves the default security group for the VPC specified by the identifier in the URL. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.

GET /vpcs/{id}/default_security_group
(vpc *VpcV1) GetVPCDefaultSecurityGroup(getVPCDefaultSecurityGroupOptions *GetVPCDefaultSecurityGroupOptions) (result *DefaultSecurityGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCDefaultSecurityGroupWithContext(ctx context.Context, getVPCDefaultSecurityGroupOptions *GetVPCDefaultSecurityGroupOptions) (result *DefaultSecurityGroup, response *core.DetailedResponse, err error)
get_vpc_default_security_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DefaultSecurityGroup> getVpcDefaultSecurityGroup(GetVpcDefaultSecurityGroupOptions getVpcDefaultSecurityGroupOptions)
getVpcDefaultSecurityGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.read

List all address prefixes for a VPC

This request lists all address pool prefixes for a VPC.

This request lists all address pool prefixes for a VPC.

This request lists all address pool prefixes for a VPC.

This request lists all address pool prefixes for a VPC.

This request lists all address pool prefixes for a VPC.

GET /vpcs/{vpc_id}/address_prefixes
(vpc *VpcV1) ListVPCAddressPrefixes(listVPCAddressPrefixesOptions *ListVPCAddressPrefixesOptions) (result *AddressPrefixCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPCAddressPrefixesWithContext(ctx context.Context, listVPCAddressPrefixesOptions *ListVPCAddressPrefixesOptions) (result *AddressPrefixCollection, response *core.DetailedResponse, err error)
list_vpc_address_prefixes(
        self,
        vpc_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<AddressPrefixCollection> listVpcAddressPrefixes(ListVpcAddressPrefixesOptions listVpcAddressPrefixesOptions)
listVpcAddressPrefixes(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.address-prefix.read

Create an address prefix for a VPC

This request creates a new prefix from a prefix prototype object. The prototype object is structured in the same way as a retrieved prefix, and contains the information necessary to create the new prefix.

This request creates a new prefix from a prefix prototype object. The prototype object is structured in the same way as a retrieved prefix, and contains the information necessary to create the new prefix.

This request creates a new prefix from a prefix prototype object. The prototype object is structured in the same way as a retrieved prefix, and contains the information necessary to create the new prefix.

This request creates a new prefix from a prefix prototype object. The prototype object is structured in the same way as a retrieved prefix, and contains the information necessary to create the new prefix.

This request creates a new prefix from a prefix prototype object. The prototype object is structured in the same way as a retrieved prefix, and contains the information necessary to create the new prefix.

POST /vpcs/{vpc_id}/address_prefixes
(vpc *VpcV1) CreateVPCAddressPrefix(createVPCAddressPrefixOptions *CreateVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPCAddressPrefixWithContext(ctx context.Context, createVPCAddressPrefixOptions *CreateVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error)
create_vpc_address_prefix(
        self,
        vpc_id: str,
        cidr: str,
        zone: 'ZoneIdentity',
        *,
        is_default: Optional[bool] = None,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<AddressPrefix> createVpcAddressPrefix(CreateVpcAddressPrefixOptions createVpcAddressPrefixOptions)
createVpcAddressPrefix(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.update

Auditing

Calling this method generates the following auditing event.

  • is.vpc.address-prefix.create

Delete an address prefix

This request deletes a prefix. This operation cannot be reversed. The request will fail if any subnets use addresses from this prefix.

This request deletes a prefix. This operation cannot be reversed. The request will fail if any subnets use addresses from this prefix.

This request deletes a prefix. This operation cannot be reversed. The request will fail if any subnets use addresses from this prefix.

This request deletes a prefix. This operation cannot be reversed. The request will fail if any subnets use addresses from this prefix.

This request deletes a prefix. This operation cannot be reversed. The request will fail if any subnets use addresses from this prefix.

DELETE /vpcs/{vpc_id}/address_prefixes/{id}
(vpc *VpcV1) DeleteVPCAddressPrefix(deleteVPCAddressPrefixOptions *DeleteVPCAddressPrefixOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPCAddressPrefixWithContext(ctx context.Context, deleteVPCAddressPrefixOptions *DeleteVPCAddressPrefixOptions) (response *core.DetailedResponse, err error)
delete_vpc_address_prefix(
        self,
        vpc_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpcAddressPrefix(DeleteVpcAddressPrefixOptions deleteVpcAddressPrefixOptions)
deleteVpcAddressPrefix(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.update

Auditing

Calling this method generates the following auditing event.

  • is.vpc.address-prefix.delete

Retrieve an address prefix

This request retrieves a single prefix specified by the identifier in the URL.

This request retrieves a single prefix specified by the identifier in the URL.

This request retrieves a single prefix specified by the identifier in the URL.

This request retrieves a single prefix specified by the identifier in the URL.

This request retrieves a single prefix specified by the identifier in the URL.

GET /vpcs/{vpc_id}/address_prefixes/{id}
(vpc *VpcV1) GetVPCAddressPrefix(getVPCAddressPrefixOptions *GetVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCAddressPrefixWithContext(ctx context.Context, getVPCAddressPrefixOptions *GetVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error)
get_vpc_address_prefix(
        self,
        vpc_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<AddressPrefix> getVpcAddressPrefix(GetVpcAddressPrefixOptions getVpcAddressPrefixOptions)
getVpcAddressPrefix(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.address-prefix.read

Update an address prefix

This request updates a prefix with the information in a provided prefix patch. The prefix patch object is structured in the same way as a retrieved prefix and contains only the information to be updated.

This request updates a prefix with the information in a provided prefix patch. The prefix patch object is structured in the same way as a retrieved prefix and contains only the information to be updated.

This request updates a prefix with the information in a provided prefix patch. The prefix patch object is structured in the same way as a retrieved prefix and contains only the information to be updated.

This request updates a prefix with the information in a provided prefix patch. The prefix patch object is structured in the same way as a retrieved prefix and contains only the information to be updated.

This request updates a prefix with the information in a provided prefix patch. The prefix patch object is structured in the same way as a retrieved prefix and contains only the information to be updated.

PATCH /vpcs/{vpc_id}/address_prefixes/{id}
(vpc *VpcV1) UpdateVPCAddressPrefix(updateVPCAddressPrefixOptions *UpdateVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPCAddressPrefixWithContext(ctx context.Context, updateVPCAddressPrefixOptions *UpdateVPCAddressPrefixOptions) (result *AddressPrefix, response *core.DetailedResponse, err error)
update_vpc_address_prefix(
        self,
        vpc_id: str,
        id: str,
        address_prefix_patch: 'AddressPrefixPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<AddressPrefix> updateVpcAddressPrefix(UpdateVpcAddressPrefixOptions updateVpcAddressPrefixOptions)
updateVpcAddressPrefix(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.update

Auditing

Calling this method generates the following auditing event.

  • is.vpc.address-prefix.update

List all DNS resolution bindings for a VPC

This request lists all DNS resolution bindings for a VPC. A DNS resolution binding represents an association with another VPC for centralizing DNS name resolution.

If the VPC specified by the identifier in the URL is a DNS hub VPC (has dns.enable_hub set to true) then there is one binding for each VPC bound to the hub VPC. The endpoint gateways in the bound VPCs can allow (using allow_dns_resolution_binding) the hub VPC to centralize resolution of their DNS names.

If the VPC specified by the identifier in the URL is not a DNS hub VPC, then there is at most one binding (to a hub VPC). The endpoint gateways in the VPC specified by the identifier in the URL can allow (using allow_dns_resolution_binding) its hub VPC to centralize resolution of their DNS names.

To make use of centralized DNS resolution, a VPC bound to a DNS hub VPC must delegate DNS resolution to its hub VPC by setting dns.resolver.type to delegate.

The bindings will be sorted by their created_at property values, with newest bindings first. Bindings with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all DNS resolution bindings for a VPC. A DNS resolution binding represents an association with another VPC for centralizing DNS name resolution.

If the VPC specified by the identifier in the URL is a DNS hub VPC (has dns.enable_hub set to true) then there is one binding for each VPC bound to the hub VPC. The endpoint gateways in the bound VPCs can allow (using allow_dns_resolution_binding) the hub VPC to centralize resolution of their DNS names.

If the VPC specified by the identifier in the URL is not a DNS hub VPC, then there is at most one binding (to a hub VPC). The endpoint gateways in the VPC specified by the identifier in the URL can allow (using allow_dns_resolution_binding) its hub VPC to centralize resolution of their DNS names.

To make use of centralized DNS resolution, a VPC bound to a DNS hub VPC must delegate DNS resolution to its hub VPC by setting dns.resolver.type to delegate.

The bindings will be sorted by their created_at property values, with newest bindings first. Bindings with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all DNS resolution bindings for a VPC. A DNS resolution binding represents an association with another VPC for centralizing DNS name resolution.

If the VPC specified by the identifier in the URL is a DNS hub VPC (has dns.enable_hub set to true) then there is one binding for each VPC bound to the hub VPC. The endpoint gateways in the bound VPCs can allow (using allow_dns_resolution_binding) the hub VPC to centralize resolution of their DNS names.

If the VPC specified by the identifier in the URL is not a DNS hub VPC, then there is at most one binding (to a hub VPC). The endpoint gateways in the VPC specified by the identifier in the URL can allow (using allow_dns_resolution_binding) its hub VPC to centralize resolution of their DNS names.

To make use of centralized DNS resolution, a VPC bound to a DNS hub VPC must delegate DNS resolution to its hub VPC by setting dns.resolver.type to delegate.

The bindings will be sorted by their created_at property values, with newest bindings first. Bindings with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all DNS resolution bindings for a VPC. A DNS resolution binding represents an association with another VPC for centralizing DNS name resolution.

If the VPC specified by the identifier in the URL is a DNS hub VPC (has dns.enable_hub set to true) then there is one binding for each VPC bound to the hub VPC. The endpoint gateways in the bound VPCs can allow (using allow_dns_resolution_binding) the hub VPC to centralize resolution of their DNS names.

If the VPC specified by the identifier in the URL is not a DNS hub VPC, then there is at most one binding (to a hub VPC). The endpoint gateways in the VPC specified by the identifier in the URL can allow (using allow_dns_resolution_binding) its hub VPC to centralize resolution of their DNS names.

To make use of centralized DNS resolution, a VPC bound to a DNS hub VPC must delegate DNS resolution to its hub VPC by setting dns.resolver.type to delegate.

The bindings will be sorted by their created_at property values, with newest bindings first. Bindings with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all DNS resolution bindings for a VPC. A DNS resolution binding represents an association with another VPC for centralizing DNS name resolution.

If the VPC specified by the identifier in the URL is a DNS hub VPC (has dns.enable_hub set to true) then there is one binding for each VPC bound to the hub VPC. The endpoint gateways in the bound VPCs can allow (using allow_dns_resolution_binding) the hub VPC to centralize resolution of their DNS names.

If the VPC specified by the identifier in the URL is not a DNS hub VPC, then there is at most one binding (to a hub VPC). The endpoint gateways in the VPC specified by the identifier in the URL can allow (using allow_dns_resolution_binding) its hub VPC to centralize resolution of their DNS names.

To make use of centralized DNS resolution, a VPC bound to a DNS hub VPC must delegate DNS resolution to its hub VPC by setting dns.resolver.type to delegate.

The bindings will be sorted by their created_at property values, with newest bindings first. Bindings with identical created_at property values will in turn be sorted by ascending name property values.

GET /vpcs/{vpc_id}/dns_resolution_bindings
(vpc *VpcV1) ListVPCDnsResolutionBindings(listVPCDnsResolutionBindingsOptions *ListVPCDnsResolutionBindingsOptions) (result *VpcdnsResolutionBindingCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPCDnsResolutionBindingsWithContext(ctx context.Context, listVPCDnsResolutionBindingsOptions *ListVPCDnsResolutionBindingsOptions) (result *VpcdnsResolutionBindingCollection, response *core.DetailedResponse, err error)
list_vpc_dns_resolution_bindings(
        self,
        vpc_id: str,
        *,
        sort: Optional[str] = None,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        name: Optional[str] = None,
        vpc_crn: Optional[str] = None,
        vpc_name: Optional[str] = None,
        account_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPCDNSResolutionBindingCollection> listVpcDnsResolutionBindings(ListVpcDnsResolutionBindingsOptions listVpcDnsResolutionBindingsOptions)
listVpcDnsResolutionBindings(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.dns-resolution-binding.list

Auditing

Calling this method generates the following auditing event.

  • is.vpc.dns-resolution-binding.list

Create a DNS resolution binding

This request creates a new DNS resolution binding from a DNS resolution binding prototype object. The prototype object is structured in the same way as a retrieved DNS resolution binding, and contains the information necessary to create the new DNS resolution binding.

For this request to succeed, dns.enable_hub must be false for the VPC specified by the identifier in the URL, and the VPC must not already have a DNS resolution binding.

See About DNS sharing for VPE gateways for more information.

This request creates a new DNS resolution binding from a DNS resolution binding prototype object. The prototype object is structured in the same way as a retrieved DNS resolution binding, and contains the information necessary to create the new DNS resolution binding.

For this request to succeed, dns.enable_hub must be false for the VPC specified by the identifier in the URL, and the VPC must not already have a DNS resolution binding.

See About DNS sharing for VPE gateways for more information.

This request creates a new DNS resolution binding from a DNS resolution binding prototype object. The prototype object is structured in the same way as a retrieved DNS resolution binding, and contains the information necessary to create the new DNS resolution binding.

For this request to succeed, dns.enable_hub must be false for the VPC specified by the identifier in the URL, and the VPC must not already have a DNS resolution binding.

See About DNS sharing for VPE gateways for more information.

This request creates a new DNS resolution binding from a DNS resolution binding prototype object. The prototype object is structured in the same way as a retrieved DNS resolution binding, and contains the information necessary to create the new DNS resolution binding.

For this request to succeed, dns.enable_hub must be false for the VPC specified by the identifier in the URL, and the VPC must not already have a DNS resolution binding.

See About DNS sharing for VPE gateways for more information.

This request creates a new DNS resolution binding from a DNS resolution binding prototype object. The prototype object is structured in the same way as a retrieved DNS resolution binding, and contains the information necessary to create the new DNS resolution binding.

For this request to succeed, dns.enable_hub must be false for the VPC specified by the identifier in the URL, and the VPC must not already have a DNS resolution binding.

See About DNS sharing for VPE gateways for more information.

POST /vpcs/{vpc_id}/dns_resolution_bindings
(vpc *VpcV1) CreateVPCDnsResolutionBinding(createVPCDnsResolutionBindingOptions *CreateVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPCDnsResolutionBindingWithContext(ctx context.Context, createVPCDnsResolutionBindingOptions *CreateVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error)
create_vpc_dns_resolution_binding(
        self,
        vpc_id: str,
        vpc: 'VPCIdentity',
        *,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPCDNSResolutionBinding> createVpcDnsResolutionBinding(CreateVpcDnsResolutionBindingOptions createVpcDnsResolutionBindingOptions)
createVpcDnsResolutionBinding(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpc.vpc.read

    Required for the VPC specified in the DNS resolution binding.

  • is.vpc.dns-resolution-binding.create

    Required for the VPC specified by the identifier in the URL and for the VPC specified in the DNS resolution binding.

  • is.vpc.dns-resolution-binding.connect

    Required for the VPC specified in the DNS resolution binding.

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.vpc.vpc.update

    Generated for the VPC specified by the identifier in the URL and for the VPC specified in the DNS resolution binding.

  • is.vpc.dns-resolution-binding.create

    Generated for the VPC specified by the identifier in the URL.

  • is.vpc.dns-resolution-binding.connect

    Generated for the VPC specified in the DNS resolution binding.

Delete a DNS resolution binding

This request deletes a DNS resolution binding. This operation cannot be reversed.

For this request to succeed, the VPC specified by the identifier in the URL must not have dns.resolver.type set to delegated.

This request deletes a DNS resolution binding. This operation cannot be reversed.

For this request to succeed, the VPC specified by the identifier in the URL must not have dns.resolver.type set to delegated.

This request deletes a DNS resolution binding. This operation cannot be reversed.

For this request to succeed, the VPC specified by the identifier in the URL must not have dns.resolver.type set to delegated.

This request deletes a DNS resolution binding. This operation cannot be reversed.

For this request to succeed, the VPC specified by the identifier in the URL must not have dns.resolver.type set to delegated.

This request deletes a DNS resolution binding. This operation cannot be reversed.

For this request to succeed, the VPC specified by the identifier in the URL must not have dns.resolver.type set to delegated.

DELETE /vpcs/{vpc_id}/dns_resolution_bindings/{id}
(vpc *VpcV1) DeleteVPCDnsResolutionBinding(deleteVPCDnsResolutionBindingOptions *DeleteVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPCDnsResolutionBindingWithContext(ctx context.Context, deleteVPCDnsResolutionBindingOptions *DeleteVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error)
delete_vpc_dns_resolution_binding(
        self,
        vpc_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPCDNSResolutionBinding> deleteVpcDnsResolutionBinding(DeleteVpcDnsResolutionBindingOptions deleteVpcDnsResolutionBindingOptions)
deleteVpcDnsResolutionBinding(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpc.dns-resolution-binding.delete

    Required for the VPC specified by the identifier in the URL.

  • is.vpc.dns-resolution-binding.disconnect

    Required for the VPC specified by the identifier in the URL if dns.enable_hub is true, otherwise required for the VPC specified in the DNS resolution binding.

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.vpc.vpc.update

    Generated for the VPC specified by the identifier in the URL.

  • is.vpc.dns-resolution-binding.delete

    Generated for the VPC specified by the identifier in the URL.

  • is.vpc.dns-resolution-binding.disconnect

    Generated for the VPC specified by the identifier in the URL if dns.enable_hub is true, otherwise generated for the VPC specified in the DNS resolution binding.

Retrieve a DNS resolution binding

This request retrieves a single DNS resolution binding specified by the identifier in the URL.

This request retrieves a single DNS resolution binding specified by the identifier in the URL.

This request retrieves a single DNS resolution binding specified by the identifier in the URL.

This request retrieves a single DNS resolution binding specified by the identifier in the URL.

This request retrieves a single DNS resolution binding specified by the identifier in the URL.

GET /vpcs/{vpc_id}/dns_resolution_bindings/{id}
(vpc *VpcV1) GetVPCDnsResolutionBinding(getVPCDnsResolutionBindingOptions *GetVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCDnsResolutionBindingWithContext(ctx context.Context, getVPCDnsResolutionBindingOptions *GetVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error)
get_vpc_dns_resolution_binding(
        self,
        vpc_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPCDNSResolutionBinding> getVpcDnsResolutionBinding(GetVpcDnsResolutionBindingOptions getVpcDnsResolutionBindingOptions)
getVpcDnsResolutionBinding(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.dns-resolution-binding.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.dns-resolution-binding.read

Update a DNS resolution binding

This request updates a DNS resolution binding with the information in a provided DNS resolution binding patch. The DNS resolution binding patch object is structured in the same way as a retrieved DNS resolution binding and contains only the information to be updated.

This request updates a DNS resolution binding with the information in a provided DNS resolution binding patch. The DNS resolution binding patch object is structured in the same way as a retrieved DNS resolution binding and contains only the information to be updated.

This request updates a DNS resolution binding with the information in a provided DNS resolution binding patch. The DNS resolution binding patch object is structured in the same way as a retrieved DNS resolution binding and contains only the information to be updated.

This request updates a DNS resolution binding with the information in a provided DNS resolution binding patch. The DNS resolution binding patch object is structured in the same way as a retrieved DNS resolution binding and contains only the information to be updated.

This request updates a DNS resolution binding with the information in a provided DNS resolution binding patch. The DNS resolution binding patch object is structured in the same way as a retrieved DNS resolution binding and contains only the information to be updated.

PATCH /vpcs/{vpc_id}/dns_resolution_bindings/{id}
(vpc *VpcV1) UpdateVPCDnsResolutionBinding(updateVPCDnsResolutionBindingOptions *UpdateVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPCDnsResolutionBindingWithContext(ctx context.Context, updateVPCDnsResolutionBindingOptions *UpdateVPCDnsResolutionBindingOptions) (result *VpcdnsResolutionBinding, response *core.DetailedResponse, err error)
update_vpc_dns_resolution_binding(
        self,
        vpc_id: str,
        id: str,
        vpcdns_resolution_binding_patch: 'VPCDNSResolutionBindingPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPCDNSResolutionBinding> updateVpcDnsResolutionBinding(UpdateVpcDnsResolutionBindingOptions updateVpcDnsResolutionBindingOptions)
updateVpcDnsResolutionBinding(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.dns-resolution-binding.update

Auditing

Calling this method generates the following auditing event.

  • is.vpc.dns-resolution-binding.update

List all routes in a VPC's default routing table

This request lists all routes in the VPC's default routing table. Each route is zone-specific and directs any packets matching its destination CIDR block to a next_hop IP address. The most specific route matching a packet's destination will be used. If multiple equally-specific routes exist, traffic will be distributed across them.

This request lists all routes in the VPC's default routing table. Each route is zone-specific and directs any packets matching its destination CIDR block to a next_hop IP address. The most specific route matching a packet's destination will be used. If multiple equally-specific routes exist, traffic will be distributed across them.

This request lists all routes in the VPC's default routing table. Each route is zone-specific and directs any packets matching its destination CIDR block to a next_hop IP address. The most specific route matching a packet's destination will be used. If multiple equally-specific routes exist, traffic will be distributed across them.

This request lists all routes in the VPC's default routing table. Each route is zone-specific and directs any packets matching its destination CIDR block to a next_hop IP address. The most specific route matching a packet's destination will be used. If multiple equally-specific routes exist, traffic will be distributed across them.

This request lists all routes in the VPC's default routing table. Each route is zone-specific and directs any packets matching its destination CIDR block to a next_hop IP address. The most specific route matching a packet's destination will be used. If multiple equally-specific routes exist, traffic will be distributed across them.

GET /vpcs/{vpc_id}/routes
(vpc *VpcV1) ListVPCRoutes(listVPCRoutesOptions *ListVPCRoutesOptions) (result *RouteCollectionVPCContext, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPCRoutesWithContext(ctx context.Context, listVPCRoutesOptions *ListVPCRoutesOptions) (result *RouteCollectionVPCContext, response *core.DetailedResponse, err error)
list_vpc_routes(
        self,
        vpc_id: str,
        *,
        zone_name: Optional[str] = None,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RouteCollectionVPCContext> listVpcRoutes(ListVpcRoutesOptions listVpcRoutesOptions)
listVpcRoutes(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.read

Create a route in a VPC's default routing table

This request creates a new route in the VPC's default routing table. The route prototype object is structured in the same way as a retrieved route, and contains the information necessary to create the new route. The request will fail if the new route will cause a loop.

This request creates a new route in the VPC's default routing table. The route prototype object is structured in the same way as a retrieved route, and contains the information necessary to create the new route. The request will fail if the new route will cause a loop.

This request creates a new route in the VPC's default routing table. The route prototype object is structured in the same way as a retrieved route, and contains the information necessary to create the new route. The request will fail if the new route will cause a loop.

This request creates a new route in the VPC's default routing table. The route prototype object is structured in the same way as a retrieved route, and contains the information necessary to create the new route. The request will fail if the new route will cause a loop.

This request creates a new route in the VPC's default routing table. The route prototype object is structured in the same way as a retrieved route, and contains the information necessary to create the new route. The request will fail if the new route will cause a loop.

POST /vpcs/{vpc_id}/routes
(vpc *VpcV1) CreateVPCRoute(createVPCRouteOptions *CreateVPCRouteOptions) (result *CreateVPCRouteResponse, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPCRouteWithContext(ctx context.Context, createVPCRouteOptions *CreateVPCRouteOptions) (result *CreateVPCRouteResponse, response *core.DetailedResponse, err error)
create_vpc_route(
        self,
        vpc_id: str,
        destination: str,
        zone: 'ZoneIdentity',
        *,
        action: Optional[str] = None,
        advertise: Optional[bool] = None,
        name: Optional[str] = None,
        next_hop: Optional['RoutePrototypeNextHop'] = None,
        priority: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<CreateVpcRouteResponse> createVpcRoute(CreateVpcRouteOptions createVpcRouteOptions)
createVpcRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.update

  • is.vpc.routing-table.advertise

    Required when advertise is true.

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.create

Delete a VPC route

This request deletes a route. This operation cannot be reversed.

This request deletes a route. This operation cannot be reversed.

This request deletes a route. This operation cannot be reversed.

This request deletes a route. This operation cannot be reversed.

This request deletes a route. This operation cannot be reversed.

DELETE /vpcs/{vpc_id}/routes/{id}
(vpc *VpcV1) DeleteVPCRoute(deleteVPCRouteOptions *DeleteVPCRouteOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPCRouteWithContext(ctx context.Context, deleteVPCRouteOptions *DeleteVPCRouteOptions) (response *core.DetailedResponse, err error)
delete_vpc_route(
        self,
        vpc_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpcRoute(DeleteVpcRouteOptions deleteVpcRouteOptions)
deleteVpcRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.update

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.delete

Retrieve a VPC route

This request retrieves a single route specified by the identifier in the URL.

This request retrieves a single route specified by the identifier in the URL.

This request retrieves a single route specified by the identifier in the URL.

This request retrieves a single route specified by the identifier in the URL.

This request retrieves a single route specified by the identifier in the URL.

GET /vpcs/{vpc_id}/routes/{id}
(vpc *VpcV1) GetVPCRoute(getVPCRouteOptions *GetVPCRouteOptions) (result *GetVPCRouteResponse, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCRouteWithContext(ctx context.Context, getVPCRouteOptions *GetVPCRouteOptions) (result *GetVPCRouteResponse, response *core.DetailedResponse, err error)
get_vpc_route(
        self,
        vpc_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<GetVpcRouteResponse> getVpcRoute(GetVpcRouteOptions getVpcRouteOptions)
getVpcRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.read

Update a VPC route

This request updates a route with the information in a provided route patch. The route patch object is structured in the same way as a retrieved route and contains only the information to be updated.

This request updates a route with the information in a provided route patch. The route patch object is structured in the same way as a retrieved route and contains only the information to be updated.

This request updates a route with the information in a provided route patch. The route patch object is structured in the same way as a retrieved route and contains only the information to be updated.

This request updates a route with the information in a provided route patch. The route patch object is structured in the same way as a retrieved route and contains only the information to be updated.

This request updates a route with the information in a provided route patch. The route patch object is structured in the same way as a retrieved route and contains only the information to be updated.

PATCH /vpcs/{vpc_id}/routes/{id}
(vpc *VpcV1) UpdateVPCRoute(updateVPCRouteOptions *UpdateVPCRouteOptions) (result *UpdateVPCRouteResponse, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPCRouteWithContext(ctx context.Context, updateVPCRouteOptions *UpdateVPCRouteOptions) (result *UpdateVPCRouteResponse, response *core.DetailedResponse, err error)
update_vpc_route(
        self,
        vpc_id: str,
        id: str,
        route_patch: 'RoutePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<UpdateVpcRouteResponse> updateVpcRoute(UpdateVpcRouteOptions updateVpcRouteOptions)
updateVpcRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.update

  • is.vpc.routing-table.advertise

    Required when advertise is specified as true, or when advertise is currently true.

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.update

List all routing tables for a VPC

This request lists all routing tables for a VPC. Each subnet in a VPC is associated with a routing table, which controls delivery of packets sent on that subnet according to the action of the most specific matching route in the table. If multiple equally-specific routes exist, traffic will be distributed across them. If no routes match, delivery will be controlled by the system's built-in routes.

This request lists all routing tables for a VPC. Each subnet in a VPC is associated with a routing table, which controls delivery of packets sent on that subnet according to the action of the most specific matching route in the table. If multiple equally-specific routes exist, traffic will be distributed across them. If no routes match, delivery will be controlled by the system's built-in routes.

This request lists all routing tables for a VPC. Each subnet in a VPC is associated with a routing table, which controls delivery of packets sent on that subnet according to the action of the most specific matching route in the table. If multiple equally-specific routes exist, traffic will be distributed across them. If no routes match, delivery will be controlled by the system's built-in routes.

This request lists all routing tables for a VPC. Each subnet in a VPC is associated with a routing table, which controls delivery of packets sent on that subnet according to the action of the most specific matching route in the table. If multiple equally-specific routes exist, traffic will be distributed across them. If no routes match, delivery will be controlled by the system's built-in routes.

This request lists all routing tables for a VPC. Each subnet in a VPC is associated with a routing table, which controls delivery of packets sent on that subnet according to the action of the most specific matching route in the table. If multiple equally-specific routes exist, traffic will be distributed across them. If no routes match, delivery will be controlled by the system's built-in routes.

GET /vpcs/{vpc_id}/routing_tables
(vpc *VpcV1) ListVPCRoutingTables(listVPCRoutingTablesOptions *ListVPCRoutingTablesOptions) (result *RoutingTableCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPCRoutingTablesWithContext(ctx context.Context, listVPCRoutingTablesOptions *ListVPCRoutingTablesOptions) (result *RoutingTableCollection, response *core.DetailedResponse, err error)
list_vpc_routing_tables(
        self,
        vpc_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        is_default: Optional[bool] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RoutingTableCollection> listVpcRoutingTables(ListVpcRoutingTablesOptions listVpcRoutingTablesOptions)
listVpcRoutingTables(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.list

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table.read

Create a routing table for a VPC

This request creates a routing table from a routing table prototype object. The prototype object is structured in the same way as a retrieved routing table, and contains the information necessary to create the new routing table.

This request creates a routing table from a routing table prototype object. The prototype object is structured in the same way as a retrieved routing table, and contains the information necessary to create the new routing table.

This request creates a routing table from a routing table prototype object. The prototype object is structured in the same way as a retrieved routing table, and contains the information necessary to create the new routing table.

This request creates a routing table from a routing table prototype object. The prototype object is structured in the same way as a retrieved routing table, and contains the information necessary to create the new routing table.

This request creates a routing table from a routing table prototype object. The prototype object is structured in the same way as a retrieved routing table, and contains the information necessary to create the new routing table.

POST /vpcs/{vpc_id}/routing_tables
(vpc *VpcV1) CreateVPCRoutingTable(createVPCRoutingTableOptions *CreateVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPCRoutingTableWithContext(ctx context.Context, createVPCRoutingTableOptions *CreateVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
create_vpc_routing_table(
        self,
        vpc_id: str,
        *,
        accept_routes_from: Optional[List['ResourceFilter']] = None,
        advertise_routes_to: Optional[List[str]] = None,
        name: Optional[str] = None,
        route_direct_link_ingress: Optional[bool] = None,
        route_internet_ingress: Optional[bool] = None,
        route_transit_gateway_ingress: Optional[bool] = None,
        route_vpc_zone_ingress: Optional[bool] = None,
        routes: Optional[List['RoutePrototype']] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RoutingTable> createVpcRoutingTable(CreateVpcRoutingTableOptions createVpcRoutingTableOptions)
createVpcRoutingTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.create

  • is.vpc.routing-table.advertise

    Required when advertise_routes_to is specified and not empty.

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table.create

Delete a VPC routing table

This request deletes a routing table. A routing table cannot be deleted if it is associated with any subnets in the VPC. Additionally, a VPC's default routing table cannot be deleted. This operation cannot be reversed.

This request deletes a routing table. A routing table cannot be deleted if it is associated with any subnets in the VPC. Additionally, a VPC's default routing table cannot be deleted. This operation cannot be reversed.

This request deletes a routing table. A routing table cannot be deleted if it is associated with any subnets in the VPC. Additionally, a VPC's default routing table cannot be deleted. This operation cannot be reversed.

This request deletes a routing table. A routing table cannot be deleted if it is associated with any subnets in the VPC. Additionally, a VPC's default routing table cannot be deleted. This operation cannot be reversed.

This request deletes a routing table. A routing table cannot be deleted if it is associated with any subnets in the VPC. Additionally, a VPC's default routing table cannot be deleted. This operation cannot be reversed.

DELETE /vpcs/{vpc_id}/routing_tables/{id}
(vpc *VpcV1) DeleteVPCRoutingTable(deleteVPCRoutingTableOptions *DeleteVPCRoutingTableOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPCRoutingTableWithContext(ctx context.Context, deleteVPCRoutingTableOptions *DeleteVPCRoutingTableOptions) (response *core.DetailedResponse, err error)
delete_vpc_routing_table(
        self,
        vpc_id: str,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpcRoutingTable(DeleteVpcRoutingTableOptions deleteVpcRoutingTableOptions)
deleteVpcRoutingTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.delete

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table.delete

Retrieve a VPC routing table

This request retrieves a single routing table specified by the identifier in the URL.

This request retrieves a single routing table specified by the identifier in the URL.

This request retrieves a single routing table specified by the identifier in the URL.

This request retrieves a single routing table specified by the identifier in the URL.

This request retrieves a single routing table specified by the identifier in the URL.

GET /vpcs/{vpc_id}/routing_tables/{id}
(vpc *VpcV1) GetVPCRoutingTable(getVPCRoutingTableOptions *GetVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCRoutingTableWithContext(ctx context.Context, getVPCRoutingTableOptions *GetVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
get_vpc_routing_table(
        self,
        vpc_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RoutingTable> getVpcRoutingTable(GetVpcRoutingTableOptions getVpcRoutingTableOptions)
getVpcRoutingTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table.read

Update a VPC routing table

This request updates a routing table with the information in a provided routing table patch. The patch object is structured in the same way as a retrieved table and contains only the information to be updated.

This request updates a routing table with the information in a provided routing table patch. The patch object is structured in the same way as a retrieved table and contains only the information to be updated.

This request updates a routing table with the information in a provided routing table patch. The patch object is structured in the same way as a retrieved table and contains only the information to be updated.

This request updates a routing table with the information in a provided routing table patch. The patch object is structured in the same way as a retrieved table and contains only the information to be updated.

This request updates a routing table with the information in a provided routing table patch. The patch object is structured in the same way as a retrieved table and contains only the information to be updated.

PATCH /vpcs/{vpc_id}/routing_tables/{id}
(vpc *VpcV1) UpdateVPCRoutingTable(updateVPCRoutingTableOptions *UpdateVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPCRoutingTableWithContext(ctx context.Context, updateVPCRoutingTableOptions *UpdateVPCRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
update_vpc_routing_table(
        self,
        vpc_id: str,
        id: str,
        routing_table_patch: 'RoutingTablePatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RoutingTable> updateVpcRoutingTable(UpdateVpcRoutingTableOptions updateVpcRoutingTableOptions)
updateVpcRoutingTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.update

  • is.vpc.routing-table.advertise

    Required when advertise_routes_to is changed.

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table.update

List all routes in a VPC routing table

This request lists all routes in a VPC routing table. If subnets are associated with this routing table, delivery of packets sent on a subnet is performed according to the action of the most specific matching route in the table (provided the subnet and route are in the same zone). If multiple equally-specific routes exist, the route with the highest priority will be used. If two matching routes have the same destination and priority, traffic will be distributed between them. If no routes match, delivery will be controlled by the system's built-in routes.

This request lists all routes in a VPC routing table. If subnets are associated with this routing table, delivery of packets sent on a subnet is performed according to the action of the most specific matching route in the table (provided the subnet and route are in the same zone). If multiple equally-specific routes exist, the route with the highest priority will be used. If two matching routes have the same destination and priority, traffic will be distributed between them. If no routes match, delivery will be controlled by the system's built-in routes.

This request lists all routes in a VPC routing table. If subnets are associated with this routing table, delivery of packets sent on a subnet is performed according to the action of the most specific matching route in the table (provided the subnet and route are in the same zone). If multiple equally-specific routes exist, the route with the highest priority will be used. If two matching routes have the same destination and priority, traffic will be distributed between them. If no routes match, delivery will be controlled by the system's built-in routes.

This request lists all routes in a VPC routing table. If subnets are associated with this routing table, delivery of packets sent on a subnet is performed according to the action of the most specific matching route in the table (provided the subnet and route are in the same zone). If multiple equally-specific routes exist, the route with the highest priority will be used. If two matching routes have the same destination and priority, traffic will be distributed between them. If no routes match, delivery will be controlled by the system's built-in routes.

This request lists all routes in a VPC routing table. If subnets are associated with this routing table, delivery of packets sent on a subnet is performed according to the action of the most specific matching route in the table (provided the subnet and route are in the same zone). If multiple equally-specific routes exist, the route with the highest priority will be used. If two matching routes have the same destination and priority, traffic will be distributed between them. If no routes match, delivery will be controlled by the system's built-in routes.

GET /vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes
(vpc *VpcV1) ListVPCRoutingTableRoutes(listVPCRoutingTableRoutesOptions *ListVPCRoutingTableRoutesOptions) (result *RouteCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPCRoutingTableRoutesWithContext(ctx context.Context, listVPCRoutingTableRoutesOptions *ListVPCRoutingTableRoutesOptions) (result *RouteCollection, response *core.DetailedResponse, err error)
list_vpc_routing_table_routes(
        self,
        vpc_id: str,
        routing_table_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RouteCollection> listVpcRoutingTableRoutes(ListVpcRoutingTableRoutesOptions listVpcRoutingTableRoutesOptions)
listVpcRoutingTableRoutes(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.read

Create a route in a VPC routing table

This request creates a new VPC route from a VPC route prototype object. The prototype object is structured in the same way as a retrieved VPC route and contains the information necessary to create the route.

This request creates a new VPC route from a VPC route prototype object. The prototype object is structured in the same way as a retrieved VPC route and contains the information necessary to create the route.

This request creates a new VPC route from a VPC route prototype object. The prototype object is structured in the same way as a retrieved VPC route and contains the information necessary to create the route.

This request creates a new VPC route from a VPC route prototype object. The prototype object is structured in the same way as a retrieved VPC route and contains the information necessary to create the route.

This request creates a new VPC route from a VPC route prototype object. The prototype object is structured in the same way as a retrieved VPC route and contains the information necessary to create the route.

POST /vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes
(vpc *VpcV1) CreateVPCRoutingTableRoute(createVPCRoutingTableRouteOptions *CreateVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPCRoutingTableRouteWithContext(ctx context.Context, createVPCRoutingTableRouteOptions *CreateVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error)
create_vpc_routing_table_route(
        self,
        vpc_id: str,
        routing_table_id: str,
        destination: str,
        zone: 'ZoneIdentity',
        *,
        action: Optional[str] = None,
        advertise: Optional[bool] = None,
        name: Optional[str] = None,
        next_hop: Optional['RoutePrototypeNextHop'] = None,
        priority: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Route> createVpcRoutingTableRoute(CreateVpcRoutingTableRouteOptions createVpcRoutingTableRouteOptions)
createVpcRoutingTableRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.update

  • is.vpc.routing-table.advertise

    Required when advertise is true.

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.create

Delete a VPC routing table route

This request deletes a VPC route. This operation cannot be reversed. Only VPC routes with an origin of user are allowed to be deleted.

This request deletes a VPC route. This operation cannot be reversed. Only VPC routes with an origin of user are allowed to be deleted.

This request deletes a VPC route. This operation cannot be reversed. Only VPC routes with an origin of user are allowed to be deleted.

This request deletes a VPC route. This operation cannot be reversed. Only VPC routes with an origin of user are allowed to be deleted.

This request deletes a VPC route. This operation cannot be reversed. Only VPC routes with an origin of user are allowed to be deleted.

DELETE /vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes/{id}
(vpc *VpcV1) DeleteVPCRoutingTableRoute(deleteVPCRoutingTableRouteOptions *DeleteVPCRoutingTableRouteOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPCRoutingTableRouteWithContext(ctx context.Context, deleteVPCRoutingTableRouteOptions *DeleteVPCRoutingTableRouteOptions) (response *core.DetailedResponse, err error)
delete_vpc_routing_table_route(
        self,
        vpc_id: str,
        routing_table_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpcRoutingTableRoute(DeleteVpcRoutingTableRouteOptions deleteVpcRoutingTableRouteOptions)
deleteVpcRoutingTableRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.update

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.delete

Retrieve a VPC routing table route

This request retrieves a single VPC route specified by the identifier in the URL path.

This request retrieves a single VPC route specified by the identifier in the URL path.

This request retrieves a single VPC route specified by the identifier in the URL path.

This request retrieves a single VPC route specified by the identifier in the URL path.

This request retrieves a single VPC route specified by the identifier in the URL path.

GET /vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes/{id}
(vpc *VpcV1) GetVPCRoutingTableRoute(getVPCRoutingTableRouteOptions *GetVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPCRoutingTableRouteWithContext(ctx context.Context, getVPCRoutingTableRouteOptions *GetVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error)
get_vpc_routing_table_route(
        self,
        vpc_id: str,
        routing_table_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Route> getVpcRoutingTableRoute(GetVpcRoutingTableRouteOptions getVpcRoutingTableRouteOptions)
getVpcRoutingTableRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.read

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.read

Update a VPC routing table route

This request updates a VPC route with the information provided in a route patch object. The patch object is structured in the same way as a retrieved VPC route and needs to contain only the information to be updated. Only VPC routes with an origin of user are allowed to be updated.

This request updates a VPC route with the information provided in a route patch object. The patch object is structured in the same way as a retrieved VPC route and needs to contain only the information to be updated. Only VPC routes with an origin of user are allowed to be updated.

This request updates a VPC route with the information provided in a route patch object. The patch object is structured in the same way as a retrieved VPC route and needs to contain only the information to be updated. Only VPC routes with an origin of user are allowed to be updated.

This request updates a VPC route with the information provided in a route patch object. The patch object is structured in the same way as a retrieved VPC route and needs to contain only the information to be updated. Only VPC routes with an origin of user are allowed to be updated.

This request updates a VPC route with the information provided in a route patch object. The patch object is structured in the same way as a retrieved VPC route and needs to contain only the information to be updated. Only VPC routes with an origin of user are allowed to be updated.

PATCH /vpcs/{vpc_id}/routing_tables/{routing_table_id}/routes/{id}
(vpc *VpcV1) UpdateVPCRoutingTableRoute(updateVPCRoutingTableRouteOptions *UpdateVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPCRoutingTableRouteWithContext(ctx context.Context, updateVPCRoutingTableRouteOptions *UpdateVPCRoutingTableRouteOptions) (result *Route, response *core.DetailedResponse, err error)
update_vpc_routing_table_route(
        self,
        vpc_id: str,
        routing_table_id: str,
        id: str,
        route_patch: 'RoutePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Route> updateVpcRoutingTableRoute(UpdateVpcRoutingTableRouteOptions updateVpcRoutingTableRouteOptions)
updateVpcRoutingTableRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpc.routing-table.update

  • is.vpc.routing-table.advertise

    Required when advertise is specified as true, or when advertise is currently true.

Auditing

Calling this method generates the following auditing event.

  • is.vpc.routing-table-route.update

List all subnets

This request lists all subnets in the region. Subnets are contiguous ranges of IP addresses specified in CIDR block notation. Each subnet is within a particular zone and cannot span multiple zones or regions.

This request lists all subnets in the region. Subnets are contiguous ranges of IP addresses specified in CIDR block notation. Each subnet is within a particular zone and cannot span multiple zones or regions.

This request lists all subnets in the region. Subnets are contiguous ranges of IP addresses specified in CIDR block notation. Each subnet is within a particular zone and cannot span multiple zones or regions.

This request lists all subnets in the region. Subnets are contiguous ranges of IP addresses specified in CIDR block notation. Each subnet is within a particular zone and cannot span multiple zones or regions.

This request lists all subnets in the region. Subnets are contiguous ranges of IP addresses specified in CIDR block notation. Each subnet is within a particular zone and cannot span multiple zones or regions.

GET /subnets
(vpc *VpcV1) ListSubnets(listSubnetsOptions *ListSubnetsOptions) (result *SubnetCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSubnetsWithContext(ctx context.Context, listSubnetsOptions *ListSubnetsOptions) (result *SubnetCollection, response *core.DetailedResponse, err error)
list_subnets(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        zone_name: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_crn: Optional[str] = None,
        vpc_name: Optional[str] = None,
        routing_table_id: Optional[str] = None,
        routing_table_name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SubnetCollection> listSubnets(ListSubnetsOptions listSubnetsOptions)
listSubnets(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.list

  • is.subnet.subnet.read

Auditing

Calling this method generates the following auditing event.

  • is.subnet.subnet.read

Create a subnet

This request creates a new subnet from a subnet prototype object. The prototype object is structured in the same way as a retrieved subnet, and contains the information necessary to create the new subnet. For this request to succeed, the prototype's CIDR block must not overlap with an existing subnet in the VPC.

This request creates a new subnet from a subnet prototype object. The prototype object is structured in the same way as a retrieved subnet, and contains the information necessary to create the new subnet. For this request to succeed, the prototype's CIDR block must not overlap with an existing subnet in the VPC.

This request creates a new subnet from a subnet prototype object. The prototype object is structured in the same way as a retrieved subnet, and contains the information necessary to create the new subnet. For this request to succeed, the prototype's CIDR block must not overlap with an existing subnet in the VPC.

This request creates a new subnet from a subnet prototype object. The prototype object is structured in the same way as a retrieved subnet, and contains the information necessary to create the new subnet. For this request to succeed, the prototype's CIDR block must not overlap with an existing subnet in the VPC.

This request creates a new subnet from a subnet prototype object. The prototype object is structured in the same way as a retrieved subnet, and contains the information necessary to create the new subnet. For this request to succeed, the prototype's CIDR block must not overlap with an existing subnet in the VPC.

POST /subnets
(vpc *VpcV1) CreateSubnet(createSubnetOptions *CreateSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateSubnetWithContext(ctx context.Context, createSubnetOptions *CreateSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error)
create_subnet(
        self,
        subnet_prototype: 'SubnetPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Subnet> createSubnet(CreateSubnetOptions createSubnetOptions)
createSubnet(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.create

  • is.vpc.vpc.operate

  • is.public-gateway.public-gateway.operate

    Required when public_gateway is specified

  • is.network-acl.network-acl.operate

  • is.vpc.routing-table.operate

Auditing

Calling this method generates the following auditing event.

  • is.subnet.subnet.create

Delete a subnet

This request deletes a subnet. This operation cannot be reversed. For this request to succeed, the subnet must not be referenced by any bare metal server network interfaces, instance network interfaces, virtual network interfaces, VPN gateways, or load balancers. A delete operation automatically detaches the subnet from any network ACLs, public gateways, or endpoint gateways. All flow log collectors with auto_delete set to true targeting the subnet or any resource in the subnet are automatically deleted.

This request deletes a subnet. This operation cannot be reversed. For this request to succeed, the subnet must not be referenced by any bare metal server network interfaces, instance network interfaces, virtual network interfaces, VPN gateways, or load balancers. A delete operation automatically detaches the subnet from any network ACLs, public gateways, or endpoint gateways. All flow log collectors with auto_delete set to true targeting the subnet or any resource in the subnet are automatically deleted.

This request deletes a subnet. This operation cannot be reversed. For this request to succeed, the subnet must not be referenced by any bare metal server network interfaces, instance network interfaces, virtual network interfaces, VPN gateways, or load balancers. A delete operation automatically detaches the subnet from any network ACLs, public gateways, or endpoint gateways. All flow log collectors with auto_delete set to true targeting the subnet or any resource in the subnet are automatically deleted.

This request deletes a subnet. This operation cannot be reversed. For this request to succeed, the subnet must not be referenced by any bare metal server network interfaces, instance network interfaces, virtual network interfaces, VPN gateways, or load balancers. A delete operation automatically detaches the subnet from any network ACLs, public gateways, or endpoint gateways. All flow log collectors with auto_delete set to true targeting the subnet or any resource in the subnet are automatically deleted.

This request deletes a subnet. This operation cannot be reversed. For this request to succeed, the subnet must not be referenced by any bare metal server network interfaces, instance network interfaces, virtual network interfaces, VPN gateways, or load balancers. A delete operation automatically detaches the subnet from any network ACLs, public gateways, or endpoint gateways. All flow log collectors with auto_delete set to true targeting the subnet or any resource in the subnet are automatically deleted.

DELETE /subnets/{id}
(vpc *VpcV1) DeleteSubnet(deleteSubnetOptions *DeleteSubnetOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSubnetWithContext(ctx context.Context, deleteSubnetOptions *DeleteSubnetOptions) (response *core.DetailedResponse, err error)
delete_subnet(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteSubnet(DeleteSubnetOptions deleteSubnetOptions)
deleteSubnet(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.subnet.subnet.detach

    Generated for each resource that was attached to this subnet:

    • a flow log collector
    • a public gateway
    • a network ACL
    • a routing table

  • is.public-gateway.public-gateway.detach

    Generated when the subnet has public_gateway set.

  • is.network-acl.network-acl.detach

  • is.vpc.routing-table.detach

  • is.flow-log-collector.flow-log-collector.delete

    Generated when a flow log collector that had auto_delete set to true was attached to the subnet.

  • is.flow-log-collector.flow-log-collector.detach

    Generated when a flow log collector was attached to the subnet

  • is.subnet.subnet.delete

Retrieve a subnet

This request retrieves a single subnet specified by the identifier in the URL.

This request retrieves a single subnet specified by the identifier in the URL.

This request retrieves a single subnet specified by the identifier in the URL.

This request retrieves a single subnet specified by the identifier in the URL.

This request retrieves a single subnet specified by the identifier in the URL.

GET /subnets/{id}
(vpc *VpcV1) GetSubnet(getSubnetOptions *GetSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSubnetWithContext(ctx context.Context, getSubnetOptions *GetSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error)
get_subnet(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Subnet> getSubnet(GetSubnetOptions getSubnetOptions)
getSubnet(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.read

Auditing

Calling this method generates the following auditing event.

  • is.subnet.subnet.read

Update a subnet

This request updates a subnet with the information in a provided subnet patch. The subnet patch object is structured in the same way as a retrieved subnet and contains only the information to be updated.

This request updates a subnet with the information in a provided subnet patch. The subnet patch object is structured in the same way as a retrieved subnet and contains only the information to be updated.

This request updates a subnet with the information in a provided subnet patch. The subnet patch object is structured in the same way as a retrieved subnet and contains only the information to be updated.

This request updates a subnet with the information in a provided subnet patch. The subnet patch object is structured in the same way as a retrieved subnet and contains only the information to be updated.

This request updates a subnet with the information in a provided subnet patch. The subnet patch object is structured in the same way as a retrieved subnet and contains only the information to be updated.

PATCH /subnets/{id}
(vpc *VpcV1) UpdateSubnet(updateSubnetOptions *UpdateSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateSubnetWithContext(ctx context.Context, updateSubnetOptions *UpdateSubnetOptions) (result *Subnet, response *core.DetailedResponse, err error)
update_subnet(
        self,
        id: str,
        subnet_patch: 'SubnetPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Subnet> updateSubnet(UpdateSubnetOptions updateSubnetOptions)
updateSubnet(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.update

  • is.public-gateway.public-gateway.operate

    Required when public_gateway is specified

  • is.network-acl.network-acl.operate

    Required when network_acl is specified

  • is.vpc.routing-table.operate

    Required when routing_table is changed

Auditing

Calling this method generates the following auditing event.

  • is.subnet.subnet.update

Retrieve a subnet's attached network ACL

This request retrieves the network ACL attached to the subnet specified by the identifier in the URL.

This request retrieves the network ACL attached to the subnet specified by the identifier in the URL.

This request retrieves the network ACL attached to the subnet specified by the identifier in the URL.

This request retrieves the network ACL attached to the subnet specified by the identifier in the URL.

This request retrieves the network ACL attached to the subnet specified by the identifier in the URL.

GET /subnets/{id}/network_acl
(vpc *VpcV1) GetSubnetNetworkACL(getSubnetNetworkACLOptions *GetSubnetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSubnetNetworkACLWithContext(ctx context.Context, getSubnetNetworkACLOptions *GetSubnetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
get_subnet_network_acl(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACL> getSubnetNetworkAcl(GetSubnetNetworkAclOptions getSubnetNetworkAclOptions)
getSubnetNetworkAcl(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.read

  • is.network-acl.network-acl.read

Auditing

Calling this method generates the following auditing event.

  • is.subnet.subnet.read

Replace the network ACL for a subnet

This request replaces the existing network ACL for a subnet with the network ACL specified in the request body.

This request replaces the existing network ACL for a subnet with the network ACL specified in the request body.

This request replaces the existing network ACL for a subnet with the network ACL specified in the request body.

This request replaces the existing network ACL for a subnet with the network ACL specified in the request body.

This request replaces the existing network ACL for a subnet with the network ACL specified in the request body.

PUT /subnets/{id}/network_acl
(vpc *VpcV1) ReplaceSubnetNetworkACL(replaceSubnetNetworkACLOptions *ReplaceSubnetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
(vpc *VpcV1) ReplaceSubnetNetworkACLWithContext(ctx context.Context, replaceSubnetNetworkACLOptions *ReplaceSubnetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
replace_subnet_network_acl(
        self,
        id: str,
        network_acl_identity: 'NetworkACLIdentity',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACL> replaceSubnetNetworkAcl(ReplaceSubnetNetworkAclOptions replaceSubnetNetworkAclOptions)
replaceSubnetNetworkAcl(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.operate

  • is.network-acl.network-acl.operate

Auditing

Calling this method generates the following auditing event.

  • is.subnet.network-acl.update

Detach a public gateway from a subnet

This request detaches the public gateway from the subnet specified by the subnet identifier in the URL.

This request detaches the public gateway from the subnet specified by the subnet identifier in the URL.

This request detaches the public gateway from the subnet specified by the subnet identifier in the URL.

This request detaches the public gateway from the subnet specified by the subnet identifier in the URL.

This request detaches the public gateway from the subnet specified by the subnet identifier in the URL.

DELETE /subnets/{id}/public_gateway
(vpc *VpcV1) UnsetSubnetPublicGateway(unsetSubnetPublicGatewayOptions *UnsetSubnetPublicGatewayOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) UnsetSubnetPublicGatewayWithContext(ctx context.Context, unsetSubnetPublicGatewayOptions *UnsetSubnetPublicGatewayOptions) (response *core.DetailedResponse, err error)
unset_subnet_public_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> unsetSubnetPublicGateway(UnsetSubnetPublicGatewayOptions unsetSubnetPublicGatewayOptions)
unsetSubnetPublicGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.operate

  • is.public-gateway.public-gateway.operate

Auditing

Calling this method generates the following auditing events.

  • is.subnet.subnet.detach

  • is.public-gateway.public-gateway.detach

Retrieve a subnet's attached public gateway

This request retrieves the public gateway attached to the subnet specified by the identifier in the URL.

This request retrieves the public gateway attached to the subnet specified by the identifier in the URL.

This request retrieves the public gateway attached to the subnet specified by the identifier in the URL.

This request retrieves the public gateway attached to the subnet specified by the identifier in the URL.

This request retrieves the public gateway attached to the subnet specified by the identifier in the URL.

GET /subnets/{id}/public_gateway
(vpc *VpcV1) GetSubnetPublicGateway(getSubnetPublicGatewayOptions *GetSubnetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSubnetPublicGatewayWithContext(ctx context.Context, getSubnetPublicGatewayOptions *GetSubnetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
get_subnet_public_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PublicGateway> getSubnetPublicGateway(GetSubnetPublicGatewayOptions getSubnetPublicGatewayOptions)
getSubnetPublicGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.read

  • is.public-gateway.public-gateway.read

Auditing

Calling this method generates the following auditing event.

  • is.subnet.public-gateway.read

Attach a public gateway to a subnet

This request attaches the public gateway, specified in the request body, to the subnet specified by the subnet identifier in the URL. The public gateway must have the same VPC and zone as the subnet.

This request attaches the public gateway, specified in the request body, to the subnet specified by the subnet identifier in the URL. The public gateway must have the same VPC and zone as the subnet.

This request attaches the public gateway, specified in the request body, to the subnet specified by the subnet identifier in the URL. The public gateway must have the same VPC and zone as the subnet.

This request attaches the public gateway, specified in the request body, to the subnet specified by the subnet identifier in the URL. The public gateway must have the same VPC and zone as the subnet.

This request attaches the public gateway, specified in the request body, to the subnet specified by the subnet identifier in the URL. The public gateway must have the same VPC and zone as the subnet.

PUT /subnets/{id}/public_gateway
(vpc *VpcV1) SetSubnetPublicGateway(setSubnetPublicGatewayOptions *SetSubnetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
(vpc *VpcV1) SetSubnetPublicGatewayWithContext(ctx context.Context, setSubnetPublicGatewayOptions *SetSubnetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
set_subnet_public_gateway(
        self,
        id: str,
        public_gateway_identity: 'PublicGatewayIdentity',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PublicGateway> setSubnetPublicGateway(SetSubnetPublicGatewayOptions setSubnetPublicGatewayOptions)
setSubnetPublicGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.operate

  • is.public-gateway.public-gateway.operate

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.subnet.subnet.attach

  • is.subnet.subnet.detach

    Generated for the replaced public gateway (if any)

  • is.public-gateway.public-gateway.detach

    Generated for the replaced public gateway (if any)

  • is.public-gateway.public-gateway.attach

Retrieve a subnet's attached routing table

This request retrieves the routing table attached to the subnet specified by the identifier in the URL.

This request retrieves the routing table attached to the subnet specified by the identifier in the URL.

This request retrieves the routing table attached to the subnet specified by the identifier in the URL.

This request retrieves the routing table attached to the subnet specified by the identifier in the URL.

This request retrieves the routing table attached to the subnet specified by the identifier in the URL.

GET /subnets/{id}/routing_table
(vpc *VpcV1) GetSubnetRoutingTable(getSubnetRoutingTableOptions *GetSubnetRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSubnetRoutingTableWithContext(ctx context.Context, getSubnetRoutingTableOptions *GetSubnetRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
get_subnet_routing_table(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RoutingTable> getSubnetRoutingTable(GetSubnetRoutingTableOptions getSubnetRoutingTableOptions)
getSubnetRoutingTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.read

  • is.vpc.routing-table.read

    Required for the VPC with the attached routing table

Auditing

Calling this method generates the following auditing event.

  • is.subnet.routing-table.read

Replace the routing table for a subnet

This request replaces the existing routing table for a subnet with the routing table specified in the request body.

For this request to succeed, the routing table route_direct_link_ingress, route_internet_ingress, route_transit_gateway_ingress, and route_vpc_zone_ingress properties must be false.

This request replaces the existing routing table for a subnet with the routing table specified in the request body.

For this request to succeed, the routing table route_direct_link_ingress, route_internet_ingress, route_transit_gateway_ingress, and route_vpc_zone_ingress properties must be false.

This request replaces the existing routing table for a subnet with the routing table specified in the request body.

For this request to succeed, the routing table route_direct_link_ingress, route_internet_ingress, route_transit_gateway_ingress, and route_vpc_zone_ingress properties must be false.

This request replaces the existing routing table for a subnet with the routing table specified in the request body.

For this request to succeed, the routing table route_direct_link_ingress, route_internet_ingress, route_transit_gateway_ingress, and route_vpc_zone_ingress properties must be false.

This request replaces the existing routing table for a subnet with the routing table specified in the request body.

For this request to succeed, the routing table route_direct_link_ingress, route_internet_ingress, route_transit_gateway_ingress, and route_vpc_zone_ingress properties must be false.

PUT /subnets/{id}/routing_table
(vpc *VpcV1) ReplaceSubnetRoutingTable(replaceSubnetRoutingTableOptions *ReplaceSubnetRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
(vpc *VpcV1) ReplaceSubnetRoutingTableWithContext(ctx context.Context, replaceSubnetRoutingTableOptions *ReplaceSubnetRoutingTableOptions) (result *RoutingTable, response *core.DetailedResponse, err error)
replace_subnet_routing_table(
        self,
        id: str,
        routing_table_identity: 'RoutingTableIdentity',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RoutingTable> replaceSubnetRoutingTable(ReplaceSubnetRoutingTableOptions replaceSubnetRoutingTableOptions)
replaceSubnetRoutingTable(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.operate

  • is.vpc.routing-table.operate

    Required for the VPC with the routing table being replaced

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.subnet.subnet.attach

  • is.subnet.subnet.detach

    Generated for the replaced routing table

  • is.vpc.routing-table.detach

    Generated for the replaced routing table

  • is.vpc.routing-table.attach

List all reserved IPs in a subnet

This request lists all reserved IPs in a subnet. A reserved IP resource will exist for every address in the subnet which is not available for use.

This request lists all reserved IPs in a subnet. A reserved IP resource will exist for every address in the subnet which is not available for use.

This request lists all reserved IPs in a subnet. A reserved IP resource will exist for every address in the subnet which is not available for use.

This request lists all reserved IPs in a subnet. A reserved IP resource will exist for every address in the subnet which is not available for use.

This request lists all reserved IPs in a subnet. A reserved IP resource will exist for every address in the subnet which is not available for use.

GET /subnets/{subnet_id}/reserved_ips
(vpc *VpcV1) ListSubnetReservedIps(listSubnetReservedIpsOptions *ListSubnetReservedIpsOptions) (result *ReservedIPCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSubnetReservedIpsWithContext(ctx context.Context, listSubnetReservedIpsOptions *ListSubnetReservedIpsOptions) (result *ReservedIPCollection, response *core.DetailedResponse, err error)
list_subnet_reserved_ips(
        self,
        subnet_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        sort: Optional[str] = None,
        target_id: Optional[str] = None,
        target_crn: Optional[str] = None,
        target_name: Optional[str] = None,
        target_resource_type: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIPCollection> listSubnetReservedIps(ListSubnetReservedIpsOptions listSubnetReservedIpsOptions)
listSubnetReservedIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.read

Auditing

Calling this method generates the following auditing event, depending on any listed conditions.

  • is.subnet.reserved-ip.read

    Generated for each reserved IP in the list.

Reserve an IP in a subnet

This request reserves an IP address in a subnet. If the provided prototype object includes an address, the address must not already be reserved.

This request reserves an IP address in a subnet. If the provided prototype object includes an address, the address must not already be reserved.

This request reserves an IP address in a subnet. If the provided prototype object includes an address, the address must not already be reserved.

This request reserves an IP address in a subnet. If the provided prototype object includes an address, the address must not already be reserved.

This request reserves an IP address in a subnet. If the provided prototype object includes an address, the address must not already be reserved.

POST /subnets/{subnet_id}/reserved_ips
(vpc *VpcV1) CreateSubnetReservedIP(createSubnetReservedIPOptions *CreateSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateSubnetReservedIPWithContext(ctx context.Context, createSubnetReservedIPOptions *CreateSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
create_subnet_reserved_ip(
        self,
        subnet_id: str,
        *,
        address: Optional[str] = None,
        auto_delete: Optional[bool] = None,
        name: Optional[str] = None,
        target: Optional['ReservedIPTargetPrototype'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIP> createSubnetReservedIp(CreateSubnetReservedIpOptions createSubnetReservedIpOptions)
createSubnetReservedIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.update

  • is.endpoint-gateway.endpoint-gateway.operate

    Required when target specifies an endpoint gateway

  • is.virtual-network-interface.virtual-network-interface.operate

    Required when target specifies a virtual network interface

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.subnet.reserved-ip.create

  • is.subnet.subnet.update

  • is.endpoint-gateway.endpoint-gateway.attach

    Generated when target specifies an endpoint gateway

  • is.subnet.reserved-ip.attach

    Generated when target is specified

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated when target specifies a virtual network interface

Delete a reserved IP

This request releases a reserved IP. This operation cannot be reversed.

For this request to succeed, the reserved IP must not be required by another resource, such as a bare metal server network interface, instance network interface or virtual network interface for which it is the primary IP. A provider-owned reserved IP is not allowed to be deleted.

This request releases a reserved IP. This operation cannot be reversed.

For this request to succeed, the reserved IP must not be required by another resource, such as a bare metal server network interface, instance network interface or virtual network interface for which it is the primary IP. A provider-owned reserved IP is not allowed to be deleted.

This request releases a reserved IP. This operation cannot be reversed.

For this request to succeed, the reserved IP must not be required by another resource, such as a bare metal server network interface, instance network interface or virtual network interface for which it is the primary IP. A provider-owned reserved IP is not allowed to be deleted.

This request releases a reserved IP. This operation cannot be reversed.

For this request to succeed, the reserved IP must not be required by another resource, such as a bare metal server network interface, instance network interface or virtual network interface for which it is the primary IP. A provider-owned reserved IP is not allowed to be deleted.

This request releases a reserved IP. This operation cannot be reversed.

For this request to succeed, the reserved IP must not be required by another resource, such as a bare metal server network interface, instance network interface or virtual network interface for which it is the primary IP. A provider-owned reserved IP is not allowed to be deleted.

DELETE /subnets/{subnet_id}/reserved_ips/{id}
(vpc *VpcV1) DeleteSubnetReservedIP(deleteSubnetReservedIPOptions *DeleteSubnetReservedIPOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSubnetReservedIPWithContext(ctx context.Context, deleteSubnetReservedIPOptions *DeleteSubnetReservedIPOptions) (response *core.DetailedResponse, err error)
delete_subnet_reserved_ip(
        self,
        subnet_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteSubnetReservedIp(DeleteSubnetReservedIpOptions deleteSubnetReservedIpOptions)
deleteSubnetReservedIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.update

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.subnet.subnet.update

  • is.subnet.reserved-ip.delete

  • is.subnet.reserved-ip.detach

    Generated when the reserved IP was attached

  • is.endpoint-gateway.endpoint-gateway.detach

    Generated when target specified an endpoint gateway

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated when target specified a virtual network interface

Retrieve a reserved IP

This request retrieves a single reserved IP specified by the identifier in the URL.

This request retrieves a single reserved IP specified by the identifier in the URL.

This request retrieves a single reserved IP specified by the identifier in the URL.

This request retrieves a single reserved IP specified by the identifier in the URL.

This request retrieves a single reserved IP specified by the identifier in the URL.

GET /subnets/{subnet_id}/reserved_ips/{id}
(vpc *VpcV1) GetSubnetReservedIP(getSubnetReservedIPOptions *GetSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSubnetReservedIPWithContext(ctx context.Context, getSubnetReservedIPOptions *GetSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
get_subnet_reserved_ip(
        self,
        subnet_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIP> getSubnetReservedIp(GetSubnetReservedIpOptions getSubnetReservedIpOptions)
getSubnetReservedIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.read

Auditing

Calling this method generates the following auditing event.

  • is.subnet.reserved-ip.read

Update a reserved IP

This request updates a reserved IP with the information in a provided reserved IP patch. The reserved IP patch object is structured in the same way as a retrieved reserved IP and contains only the information to be updated.

A provider-owned reserved IP is not allowed to be updated.

This request updates a reserved IP with the information in a provided reserved IP patch. The reserved IP patch object is structured in the same way as a retrieved reserved IP and contains only the information to be updated.

A provider-owned reserved IP is not allowed to be updated.

This request updates a reserved IP with the information in a provided reserved IP patch. The reserved IP patch object is structured in the same way as a retrieved reserved IP and contains only the information to be updated.

A provider-owned reserved IP is not allowed to be updated.

This request updates a reserved IP with the information in a provided reserved IP patch. The reserved IP patch object is structured in the same way as a retrieved reserved IP and contains only the information to be updated.

A provider-owned reserved IP is not allowed to be updated.

This request updates a reserved IP with the information in a provided reserved IP patch. The reserved IP patch object is structured in the same way as a retrieved reserved IP and contains only the information to be updated.

A provider-owned reserved IP is not allowed to be updated.

PATCH /subnets/{subnet_id}/reserved_ips/{id}
(vpc *VpcV1) UpdateSubnetReservedIP(updateSubnetReservedIPOptions *UpdateSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateSubnetReservedIPWithContext(ctx context.Context, updateSubnetReservedIPOptions *UpdateSubnetReservedIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
update_subnet_reserved_ip(
        self,
        subnet_id: str,
        id: str,
        reserved_ip_patch: 'ReservedIPPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIP> updateSubnetReservedIp(UpdateSubnetReservedIpOptions updateSubnetReservedIpOptions)
updateSubnetReservedIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.update

Auditing

Calling this method generates the following auditing event.

  • is.subnet.reserved-ip.update

List all images

This request lists all images available in the region. An image provides source data for a volume. Images are either system-provided, or created from another source, such as importing from Cloud Object Storage.

This request lists all images available in the region. An image provides source data for a volume. Images are either system-provided, or created from another source, such as importing from Cloud Object Storage.

This request lists all images available in the region. An image provides source data for a volume. Images are either system-provided, or created from another source, such as importing from Cloud Object Storage.

This request lists all images available in the region. An image provides source data for a volume. Images are either system-provided, or created from another source, such as importing from Cloud Object Storage.

This request lists all images available in the region. An image provides source data for a volume. Images are either system-provided, or created from another source, such as importing from Cloud Object Storage.

GET /images
(vpc *VpcV1) ListImages(listImagesOptions *ListImagesOptions) (result *ImageCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListImagesWithContext(ctx context.Context, listImagesOptions *ListImagesOptions) (result *ImageCollection, response *core.DetailedResponse, err error)
list_images(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        name: Optional[str] = None,
        status: Optional[List[str]] = None,
        visibility: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ImageCollection> listImages(ListImagesOptions listImagesOptions)
listImages(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.image.image.list

  • is.image.image.read

Auditing

Calling this method generates the following auditing event.

  • is.image.image.read

Create an image

This request creates a new image from an image prototype object. The prototype object is structured in the same way as a retrieved image, and contains the information necessary to create the new image. If an image is being imported, a URL to the image file on object storage must be specified. If an image is being created from an existing volume, that volume must be specified.

This request creates a new image from an image prototype object. The prototype object is structured in the same way as a retrieved image, and contains the information necessary to create the new image. If an image is being imported, a URL to the image file on object storage must be specified. If an image is being created from an existing volume, that volume must be specified.

This request creates a new image from an image prototype object. The prototype object is structured in the same way as a retrieved image, and contains the information necessary to create the new image. If an image is being imported, a URL to the image file on object storage must be specified. If an image is being created from an existing volume, that volume must be specified.

This request creates a new image from an image prototype object. The prototype object is structured in the same way as a retrieved image, and contains the information necessary to create the new image. If an image is being imported, a URL to the image file on object storage must be specified. If an image is being created from an existing volume, that volume must be specified.

This request creates a new image from an image prototype object. The prototype object is structured in the same way as a retrieved image, and contains the information necessary to create the new image. If an image is being imported, a URL to the image file on object storage must be specified. If an image is being created from an existing volume, that volume must be specified.

POST /images
(vpc *VpcV1) CreateImage(createImageOptions *CreateImageOptions) (result *Image, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateImageWithContext(ctx context.Context, createImageOptions *CreateImageOptions) (result *Image, response *core.DetailedResponse, err error)
create_image(
        self,
        image_prototype: 'ImagePrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Image> createImage(CreateImageOptions createImageOptions)
createImage(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.image.image.create

  • is.image.image.deprecate

    Required if deprecation_at is specified.

  • is.image.image.obsolete

    Required if obsolescence_at is specified.

  • is.volume.volume.operate

    Required if an image is being created from an existing volume.

  • is.instance.instance.operate

    Required if an image is being created from an existing volume that is attached to an existing instance.

Auditing

Calling this method generates the following auditing event.

  • is.image.image.create

Delete an image

This request deletes an image. Any active image export jobs will be completed first. This operation cannot be reversed. A system-provided image is not allowed to be deleted. Additionally, an image cannot be deleted if it:

  • has a status of deleting
  • has a status of pending with a status_reasons code of image_request_in_progress
  • has catalog_offering.managed set to true

This request deletes an image. Any active image export jobs will be completed first. This operation cannot be reversed. A system-provided image is not allowed to be deleted. Additionally, an image cannot be deleted if it:

  • has a status of deleting
  • has a status of pending with a status_reasons code of image_request_in_progress
  • has catalog_offering.managed set to true.

This request deletes an image. Any active image export jobs will be completed first. This operation cannot be reversed. A system-provided image is not allowed to be deleted. Additionally, an image cannot be deleted if it:

  • has a status of deleting
  • has a status of pending with a status_reasons code of image_request_in_progress
  • has catalog_offering.managed set to true.

This request deletes an image. Any active image export jobs will be completed first. This operation cannot be reversed. A system-provided image is not allowed to be deleted. Additionally, an image cannot be deleted if it:

  • has a status of deleting
  • has a status of pending with a status_reasons code of image_request_in_progress
  • has catalog_offering.managed set to true.

This request deletes an image. Any active image export jobs will be completed first. This operation cannot be reversed. A system-provided image is not allowed to be deleted. Additionally, an image cannot be deleted if it:

  • has a status of deleting
  • has a status of pending with a status_reasons code of image_request_in_progress
  • has catalog_offering.managed set to true.
DELETE /images/{id}
(vpc *VpcV1) DeleteImage(deleteImageOptions *DeleteImageOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteImageWithContext(ctx context.Context, deleteImageOptions *DeleteImageOptions) (response *core.DetailedResponse, err error)
delete_image(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteImage(DeleteImageOptions deleteImageOptions)
deleteImage(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.image.image.delete

Auditing

Calling this method generates the following auditing event.

  • is.image.image.delete

Retrieve an image

This request retrieves a single image specified by the identifier in the URL.

This request retrieves a single image specified by the identifier in the URL.

This request retrieves a single image specified by the identifier in the URL.

This request retrieves a single image specified by the identifier in the URL.

This request retrieves a single image specified by the identifier in the URL.

GET /images/{id}
(vpc *VpcV1) GetImage(getImageOptions *GetImageOptions) (result *Image, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetImageWithContext(ctx context.Context, getImageOptions *GetImageOptions) (result *Image, response *core.DetailedResponse, err error)
get_image(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Image> getImage(GetImageOptions getImageOptions)
getImage(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.image.image.read

Auditing

Calling this method generates the following auditing event.

  • is.image.image.read

Update an image

This request updates an image with the information in a provided image patch. The image patch object is structured in the same way as a retrieved image and contains only the information to be updated. A system-provided image is not allowed to be updated. An image with a status of deleting cannot be updated.

This request updates an image with the information in a provided image patch. The image patch object is structured in the same way as a retrieved image and contains only the information to be updated. A system-provided image is not allowed to be updated. An image with a status of deleting cannot be updated.

This request updates an image with the information in a provided image patch. The image patch object is structured in the same way as a retrieved image and contains only the information to be updated. A system-provided image is not allowed to be updated. An image with a status of deleting cannot be updated.

This request updates an image with the information in a provided image patch. The image patch object is structured in the same way as a retrieved image and contains only the information to be updated. A system-provided image is not allowed to be updated. An image with a status of deleting cannot be updated.

This request updates an image with the information in a provided image patch. The image patch object is structured in the same way as a retrieved image and contains only the information to be updated. A system-provided image is not allowed to be updated. An image with a status of deleting cannot be updated.

PATCH /images/{id}
(vpc *VpcV1) UpdateImage(updateImageOptions *UpdateImageOptions) (result *Image, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateImageWithContext(ctx context.Context, updateImageOptions *UpdateImageOptions) (result *Image, response *core.DetailedResponse, err error)
update_image(
        self,
        id: str,
        image_patch: 'ImagePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Image> updateImage(UpdateImageOptions updateImageOptions)
updateImage(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.image.image.update

    Required if name is specified.

  • is.image.image.deprecate

    Required if deprecation_at is specified.

  • is.image.image.obsolete

    Required if obsolescence_at is specified.

Auditing

Calling this method generates the following auditing event.

  • is.image.image.update

Deprecate an image

This request deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time.

The image must:

  • have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

The image must not have deprecation_at set, must have catalog_offering.managed set to false, and must have a status of available.

A system-provided image is not allowed to be deprecated.

This request deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time.

The image must:

  • have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

The image must not have deprecation_at set, must have catalog_offering.managed set to false, and must have a status of available.

A system-provided image is not allowed to be deprecated.

This request deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time.

The image must:

  • have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

The image must not have deprecation_at set, must have catalog_offering.managed set to false, and must have a status of available.

A system-provided image is not allowed to be deprecated.

This request deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time.

The image must:

  • have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

The image must not have deprecation_at set, must have catalog_offering.managed set to false, and must have a status of available.

A system-provided image is not allowed to be deprecated.

This request deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time.

The image must:

  • have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

The image must not have deprecation_at set, must have catalog_offering.managed set to false, and must have a status of available.

A system-provided image is not allowed to be deprecated.

POST /images/{id}/deprecate
(vpc *VpcV1) DeprecateImage(deprecateImageOptions *DeprecateImageOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeprecateImageWithContext(ctx context.Context, deprecateImageOptions *DeprecateImageOptions) (response *core.DetailedResponse, err error)
deprecate_image(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deprecateImage(DeprecateImageOptions deprecateImageOptions)
deprecateImage(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.image.image.deprecate

Auditing

Calling this method generates the following auditing event.

  • is.image.image-status.update

Obsolete an image

This request obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time.

The image must:

  • have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set

A system-provided image is not allowed to be obsoleted.

This request obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time.

The image must:

  • have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set

A system-provided image is not allowed to be obsoleted.

This request obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time.

The image must:

  • have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set

A system-provided image is not allowed to be obsoleted.

This request obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time.

The image must:

  • have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set

A system-provided image is not allowed to be obsoleted.

This request obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time.

The image must:

  • have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set

A system-provided image is not allowed to be obsoleted.

POST /images/{id}/obsolete
(vpc *VpcV1) ObsoleteImage(obsoleteImageOptions *ObsoleteImageOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) ObsoleteImageWithContext(ctx context.Context, obsoleteImageOptions *ObsoleteImageOptions) (response *core.DetailedResponse, err error)
obsolete_image(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> obsoleteImage(ObsoleteImageOptions obsoleteImageOptions)
obsoleteImage(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.image.image.obsolete

Auditing

Calling this method generates the following auditing event.

  • is.image.image-status.update

List all image export jobs

This request lists all export jobs for an image. Each job tracks the exporting of the image to another location, such as a bucket within cloud object storage.

The jobs will be sorted by their created_at property values, with newest jobs first. Jobs with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all export jobs for an image. Each job tracks the exporting of the image to another location, such as a bucket within cloud object storage.

The jobs will be sorted by their created_at property values, with newest jobs first. Jobs with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all export jobs for an image. Each job tracks the exporting of the image to another location, such as a bucket within cloud object storage.

The jobs will be sorted by their created_at property values, with newest jobs first. Jobs with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all export jobs for an image. Each job tracks the exporting of the image to another location, such as a bucket within cloud object storage.

The jobs will be sorted by their created_at property values, with newest jobs first. Jobs with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all export jobs for an image. Each job tracks the exporting of the image to another location, such as a bucket within cloud object storage.

The jobs will be sorted by their created_at property values, with newest jobs first. Jobs with identical created_at property values will in turn be sorted by ascending name property values.

GET /images/{image_id}/export_jobs
(vpc *VpcV1) ListImageExportJobs(listImageExportJobsOptions *ListImageExportJobsOptions) (result *ImageExportJobUnpaginatedCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListImageExportJobsWithContext(ctx context.Context, listImageExportJobsOptions *ListImageExportJobsOptions) (result *ImageExportJobUnpaginatedCollection, response *core.DetailedResponse, err error)
list_image_export_jobs(
        self,
        image_id: str,
        *,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ImageExportJobUnpaginatedCollection> listImageExportJobs(ListImageExportJobsOptions listImageExportJobsOptions)
listImageExportJobs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.image.image.read

Auditing

Calling this method generates the following auditing event.

  • is.image.image-export-job.list

Create an image export job

This request creates and queues a new export job for the image specified in the URL using the image export job prototype object. The image must be owned by the account and be in the available, deprecated, obsolete, or unusable state. The prototype object is structured in the same way as a retrieved image export job, and contains the information necessary to create and queue the new image export job.

This request creates and queues a new export job for the image specified in the URL using the image export job prototype object. The image must be owned by the account and be in the available, deprecated, obsolete, or unusable state. The prototype object is structured in the same way as a retrieved image export job, and contains the information necessary to create and queue the new image export job.

This request creates and queues a new export job for the image specified in the URL using the image export job prototype object. The image must be owned by the account and be in the available, deprecated, obsolete, or unusable state. The prototype object is structured in the same way as a retrieved image export job, and contains the information necessary to create and queue the new image export job.

This request creates and queues a new export job for the image specified in the URL using the image export job prototype object. The image must be owned by the account and be in the available, deprecated, obsolete, or unusable state. The prototype object is structured in the same way as a retrieved image export job, and contains the information necessary to create and queue the new image export job.

This request creates and queues a new export job for the image specified in the URL using the image export job prototype object. The image must be owned by the account and be in the available, deprecated, obsolete, or unusable state. The prototype object is structured in the same way as a retrieved image export job, and contains the information necessary to create and queue the new image export job.

POST /images/{image_id}/export_jobs
(vpc *VpcV1) CreateImageExportJob(createImageExportJobOptions *CreateImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateImageExportJobWithContext(ctx context.Context, createImageExportJobOptions *CreateImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error)
create_image_export_job(
        self,
        image_id: str,
        storage_bucket: 'CloudObjectStorageBucketIdentity',
        *,
        format: Optional[str] = None,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ImageExportJob> createImageExportJob(CreateImageExportJobOptions createImageExportJobOptions)
createImageExportJob(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.image.image.operate

  • is.image.image.export

Auditing

Calling this method generates the following auditing events.

  • is.image.image.export

  • is.image.image-export-job.create

Delete an image export job

This request deletes an image export job. This operation cannot be reversed. If the job has not completed, the job will be canceled, and the incomplete exported image object deleted. If the job has completed, the exported image object will not be deleted.

This request deletes an image export job. This operation cannot be reversed. If the job has not completed, the job will be canceled, and the incomplete exported image object deleted. If the job has completed, the exported image object will not be deleted.

This request deletes an image export job. This operation cannot be reversed. If the job has not completed, the job will be canceled, and the incomplete exported image object deleted. If the job has completed, the exported image object will not be deleted.

This request deletes an image export job. This operation cannot be reversed. If the job has not completed, the job will be canceled, and the incomplete exported image object deleted. If the job has completed, the exported image object will not be deleted.

This request deletes an image export job. This operation cannot be reversed. If the job has not completed, the job will be canceled, and the incomplete exported image object deleted. If the job has completed, the exported image object will not be deleted.

DELETE /images/{image_id}/export_jobs/{id}
(vpc *VpcV1) DeleteImageExportJob(deleteImageExportJobOptions *DeleteImageExportJobOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteImageExportJobWithContext(ctx context.Context, deleteImageExportJobOptions *DeleteImageExportJobOptions) (response *core.DetailedResponse, err error)
delete_image_export_job(
        self,
        image_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteImageExportJob(DeleteImageExportJobOptions deleteImageExportJobOptions)
deleteImageExportJob(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.image.image.operate

  • is.image.image.export

    Required when the image export job has not yet completed.

Auditing

Calling this method generates the following auditing event.

  • is.image.image-export-job.delete

Retrieve an image export job

This request retrieves a single image export job specified by the identifier in the URL.

This request retrieves a single image export job specified by the identifier in the URL.

This request retrieves a single image export job specified by the identifier in the URL.

This request retrieves a single image export job specified by the identifier in the URL.

This request retrieves a single image export job specified by the identifier in the URL.

GET /images/{image_id}/export_jobs/{id}
(vpc *VpcV1) GetImageExportJob(getImageExportJobOptions *GetImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetImageExportJobWithContext(ctx context.Context, getImageExportJobOptions *GetImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error)
get_image_export_job(
        self,
        image_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ImageExportJob> getImageExportJob(GetImageExportJobOptions getImageExportJobOptions)
getImageExportJob(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.image.image.read

Auditing

Calling this method generates the following auditing event.

  • is.image.image-export-job.read

Update an image export job

This request updates an image export job with the information in a provided image export job patch. The image export job patch object is structured in the same way as a retrieved image export job and contains only the information to be updated.

This request updates an image export job with the information in a provided image export job patch. The image export job patch object is structured in the same way as a retrieved image export job and contains only the information to be updated.

This request updates an image export job with the information in a provided image export job patch. The image export job patch object is structured in the same way as a retrieved image export job and contains only the information to be updated.

This request updates an image export job with the information in a provided image export job patch. The image export job patch object is structured in the same way as a retrieved image export job and contains only the information to be updated.

This request updates an image export job with the information in a provided image export job patch. The image export job patch object is structured in the same way as a retrieved image export job and contains only the information to be updated.

PATCH /images/{image_id}/export_jobs/{id}
(vpc *VpcV1) UpdateImageExportJob(updateImageExportJobOptions *UpdateImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateImageExportJobWithContext(ctx context.Context, updateImageExportJobOptions *UpdateImageExportJobOptions) (result *ImageExportJob, response *core.DetailedResponse, err error)
update_image_export_job(
        self,
        image_id: str,
        id: str,
        image_export_job_patch: 'ImageExportJobPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ImageExportJob> updateImageExportJob(UpdateImageExportJobOptions updateImageExportJobOptions)
updateImageExportJob(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.image.image.update

Auditing

Calling this method generates the following auditing event.

  • is.image.image-export-job.update

List all operating systems

This request lists all operating systems in the region.

This request lists all operating systems in the region.

This request lists all operating systems in the region.

This request lists all operating systems in the region.

This request lists all operating systems in the region.

GET /operating_systems
(vpc *VpcV1) ListOperatingSystems(listOperatingSystemsOptions *ListOperatingSystemsOptions) (result *OperatingSystemCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListOperatingSystemsWithContext(ctx context.Context, listOperatingSystemsOptions *ListOperatingSystemsOptions) (result *OperatingSystemCollection, response *core.DetailedResponse, err error)
list_operating_systems(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<OperatingSystemCollection> listOperatingSystems(ListOperatingSystemsOptions listOperatingSystemsOptions)
listOperatingSystems(params)

Retrieve an operating system

This request retrieves a single operating system specified by the name in the URL.

This request retrieves a single operating system specified by the name in the URL.

This request retrieves a single operating system specified by the name in the URL.

This request retrieves a single operating system specified by the name in the URL.

This request retrieves a single operating system specified by the name in the URL.

GET /operating_systems/{name}
(vpc *VpcV1) GetOperatingSystem(getOperatingSystemOptions *GetOperatingSystemOptions) (result *OperatingSystem, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetOperatingSystemWithContext(ctx context.Context, getOperatingSystemOptions *GetOperatingSystemOptions) (result *OperatingSystem, response *core.DetailedResponse, err error)
get_operating_system(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<OperatingSystem> getOperatingSystem(GetOperatingSystemOptions getOperatingSystemOptions)
getOperatingSystem(params)

List all keys

This request lists all keys in the region. A key contains a public SSH key which may be installed on instances when they are created. Private keys are not stored.

This request lists all keys in the region. A key contains a public SSH key which may be installed on instances when they are created. Private keys are not stored.

This request lists all keys in the region. A key contains a public SSH key which may be installed on instances when they are created. Private keys are not stored.

This request lists all keys in the region. A key contains a public SSH key which may be installed on instances when they are created. Private keys are not stored.

This request lists all keys in the region. A key contains a public SSH key which may be installed on instances when they are created. Private keys are not stored.

GET /keys
(vpc *VpcV1) ListKeys(listKeysOptions *ListKeysOptions) (result *KeyCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListKeysWithContext(ctx context.Context, listKeysOptions *ListKeysOptions) (result *KeyCollection, response *core.DetailedResponse, err error)
list_keys(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<KeyCollection> listKeys(ListKeysOptions listKeysOptions)
listKeys(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.key.key.list

  • is.key.key.read

Auditing

Calling this method generates the following auditing event.

  • is.key.key.read

Create a key

This request creates a new SSH key from an key prototype object. The prototype object is structured in the same way as a retrieved key, and contains the information necessary to create the new key. The public key value must be provided.

This request creates a new SSH key from an key prototype object. The prototype object is structured in the same way as a retrieved key, and contains the information necessary to create the new key. The public key value must be provided.

This request creates a new SSH key from an key prototype object. The prototype object is structured in the same way as a retrieved key, and contains the information necessary to create the new key. The public key value must be provided.

This request creates a new SSH key from an key prototype object. The prototype object is structured in the same way as a retrieved key, and contains the information necessary to create the new key. The public key value must be provided.

This request creates a new SSH key from an key prototype object. The prototype object is structured in the same way as a retrieved key, and contains the information necessary to create the new key. The public key value must be provided.

POST /keys
(vpc *VpcV1) CreateKey(createKeyOptions *CreateKeyOptions) (result *Key, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateKeyWithContext(ctx context.Context, createKeyOptions *CreateKeyOptions) (result *Key, response *core.DetailedResponse, err error)
create_key(
        self,
        public_key: str,
        *,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        type: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Key> createKey(CreateKeyOptions createKeyOptions)
createKey(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.key.key.create

Auditing

Calling this method generates the following auditing event.

  • is.key.key.create

Delete a key

This request deletes a key. This operation cannot be reversed.

This request deletes a key. This operation cannot be reversed.

This request deletes a key. This operation cannot be reversed.

This request deletes a key. This operation cannot be reversed.

This request deletes a key. This operation cannot be reversed.

DELETE /keys/{id}
(vpc *VpcV1) DeleteKey(deleteKeyOptions *DeleteKeyOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteKeyWithContext(ctx context.Context, deleteKeyOptions *DeleteKeyOptions) (response *core.DetailedResponse, err error)
delete_key(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteKey(DeleteKeyOptions deleteKeyOptions)
deleteKey(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.key.key.delete

Auditing

Calling this method generates the following auditing event.

  • is.key.key.delete

Retrieve a key

This request retrieves a single key specified by the identifier in the URL.

This request retrieves a single key specified by the identifier in the URL.

This request retrieves a single key specified by the identifier in the URL.

This request retrieves a single key specified by the identifier in the URL.

This request retrieves a single key specified by the identifier in the URL.

GET /keys/{id}
(vpc *VpcV1) GetKey(getKeyOptions *GetKeyOptions) (result *Key, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetKeyWithContext(ctx context.Context, getKeyOptions *GetKeyOptions) (result *Key, response *core.DetailedResponse, err error)
get_key(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Key> getKey(GetKeyOptions getKeyOptions)
getKey(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.key.key.read

Auditing

Calling this method generates the following auditing event.

  • is.key.key.read

Update a key

This request updates a key's name.

This request updates a key's name.

This request updates a key's name.

This request updates a key's name.

This request updates a key's name.

PATCH /keys/{id}
(vpc *VpcV1) UpdateKey(updateKeyOptions *UpdateKeyOptions) (result *Key, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateKeyWithContext(ctx context.Context, updateKeyOptions *UpdateKeyOptions) (result *Key, response *core.DetailedResponse, err error)
update_key(
        self,
        id: str,
        key_patch: 'KeyPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Key> updateKey(UpdateKeyOptions updateKeyOptions)
updateKey(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.key.key.update

Auditing

Calling this method generates the following auditing event.

  • is.key.key.update

List all instance profiles

This request lists provisionable instance profiles in the region. An instance profile specifies the performance characteristics and pricing model for an instance.

This request lists provisionable instance profiles in the region. An instance profile specifies the performance characteristics and pricing model for an instance.

This request lists provisionable instance profiles in the region. An instance profile specifies the performance characteristics and pricing model for an instance.

This request lists provisionable instance profiles in the region. An instance profile specifies the performance characteristics and pricing model for an instance.

This request lists provisionable instance profiles in the region. An instance profile specifies the performance characteristics and pricing model for an instance.

GET /instance/profiles
(vpc *VpcV1) ListInstanceProfiles(listInstanceProfilesOptions *ListInstanceProfilesOptions) (result *InstanceProfileCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceProfilesWithContext(ctx context.Context, listInstanceProfilesOptions *ListInstanceProfilesOptions) (result *InstanceProfileCollection, response *core.DetailedResponse, err error)
list_instance_profiles(
        self,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceProfileCollection> listInstanceProfiles(ListInstanceProfilesOptions listInstanceProfilesOptions)
listInstanceProfiles(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Retrieve an instance profile

This request retrieves a single instance profile specified by the name in the URL.

This request retrieves a single instance profile specified by the name in the URL.

This request retrieves a single instance profile specified by the name in the URL.

This request retrieves a single instance profile specified by the name in the URL.

This request retrieves a single instance profile specified by the name in the URL.

GET /instance/profiles/{name}
(vpc *VpcV1) GetInstanceProfile(getInstanceProfileOptions *GetInstanceProfileOptions) (result *InstanceProfile, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceProfileWithContext(ctx context.Context, getInstanceProfileOptions *GetInstanceProfileOptions) (result *InstanceProfile, response *core.DetailedResponse, err error)
get_instance_profile(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceProfile> getInstanceProfile(GetInstanceProfileOptions getInstanceProfileOptions)
getInstanceProfile(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

List all instance templates

This request lists all instance templates in the region.

This request lists all instance templates in the region.

This request lists all instance templates in the region.

This request lists all instance templates in the region.

This request lists all instance templates in the region.

GET /instance/templates
(vpc *VpcV1) ListInstanceTemplates(listInstanceTemplatesOptions *ListInstanceTemplatesOptions) (result *InstanceTemplateCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceTemplatesWithContext(ctx context.Context, listInstanceTemplatesOptions *ListInstanceTemplatesOptions) (result *InstanceTemplateCollection, response *core.DetailedResponse, err error)
list_instance_templates(
        self,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceTemplateCollection> listInstanceTemplates(ListInstanceTemplatesOptions listInstanceTemplatesOptions)
listInstanceTemplates(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.template.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-template.instance-template.read

Create an instance template

This request creates a new instance template. The prototype object is structured in the same way as a retrieved instance template, and contains the information necessary to provision a new instance from the template.

If a source_template is specified in the prototype object, its contents are copied into the new template prior to copying any other properties provided in the prototype object.

This request creates a new instance template. The prototype object is structured in the same way as a retrieved instance template, and contains the information necessary to provision a new instance from the template.

If a source_template is specified in the prototype object, its contents are copied into the new template prior to copying any other properties provided in the prototype object.

This request creates a new instance template. The prototype object is structured in the same way as a retrieved instance template, and contains the information necessary to provision a new instance from the template.

If a source_template is specified in the prototype object, its contents are copied into the new template prior to copying any other properties provided in the prototype object.

This request creates a new instance template. The prototype object is structured in the same way as a retrieved instance template, and contains the information necessary to provision a new instance from the template.

If a source_template is specified in the prototype object, its contents are copied into the new template prior to copying any other properties provided in the prototype object.

This request creates a new instance template. The prototype object is structured in the same way as a retrieved instance template, and contains the information necessary to provision a new instance from the template.

If a source_template is specified in the prototype object, its contents are copied into the new template prior to copying any other properties provided in the prototype object.

POST /instance/templates
(vpc *VpcV1) CreateInstanceTemplate(createInstanceTemplateOptions *CreateInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceTemplateWithContext(ctx context.Context, createInstanceTemplateOptions *CreateInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error)
create_instance_template(
        self,
        instance_template_prototype: 'InstanceTemplatePrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceTemplate> createInstanceTemplate(CreateInstanceTemplateOptions createInstanceTemplateOptions)
createInstanceTemplate(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.template.create

Auditing

Calling this method generates the following auditing event.

  • is.instance-template.instance-template.create

Delete an instance template

This request deletes the instance template. This operation cannot be reversed.

This request deletes the instance template. This operation cannot be reversed.

This request deletes the instance template. This operation cannot be reversed.

This request deletes the instance template. This operation cannot be reversed.

This request deletes the instance template. This operation cannot be reversed.

DELETE /instance/templates/{id}
(vpc *VpcV1) DeleteInstanceTemplate(deleteInstanceTemplateOptions *DeleteInstanceTemplateOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceTemplateWithContext(ctx context.Context, deleteInstanceTemplateOptions *DeleteInstanceTemplateOptions) (response *core.DetailedResponse, err error)
delete_instance_template(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceTemplate(DeleteInstanceTemplateOptions deleteInstanceTemplateOptions)
deleteInstanceTemplate(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.template.delete

Auditing

Calling this method generates the following auditing event.

  • is.instance-template.instance-template.delete

Retrieve an instance template

This request retrieves a single instance template specified by the identifier in the URL.

This request retrieves a single instance template specified by the identifier in the URL.

This request retrieves a single instance template specified by the identifier in the URL.

This request retrieves a single instance template specified by the identifier in the URL.

This request retrieves a single instance template specified by the identifier in the URL.

GET /instance/templates/{id}
(vpc *VpcV1) GetInstanceTemplate(getInstanceTemplateOptions *GetInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceTemplateWithContext(ctx context.Context, getInstanceTemplateOptions *GetInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error)
get_instance_template(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceTemplate> getInstanceTemplate(GetInstanceTemplateOptions getInstanceTemplateOptions)
getInstanceTemplate(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.template.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-template.instance-template.read

Update an instance template

This request updates an instance template with the information provided in the instance template patch. The instance template patch object is structured in the same way as a retrieved instance template and contains only the information to be updated.

This request updates an instance template with the information provided in the instance template patch. The instance template patch object is structured in the same way as a retrieved instance template and contains only the information to be updated.

This request updates an instance template with the information provided in the instance template patch. The instance template patch object is structured in the same way as a retrieved instance template and contains only the information to be updated.

This request updates an instance template with the information provided in the instance template patch. The instance template patch object is structured in the same way as a retrieved instance template and contains only the information to be updated.

This request updates an instance template with the information provided in the instance template patch. The instance template patch object is structured in the same way as a retrieved instance template and contains only the information to be updated.

PATCH /instance/templates/{id}
(vpc *VpcV1) UpdateInstanceTemplate(updateInstanceTemplateOptions *UpdateInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceTemplateWithContext(ctx context.Context, updateInstanceTemplateOptions *UpdateInstanceTemplateOptions) (result InstanceTemplateIntf, response *core.DetailedResponse, err error)
update_instance_template(
        self,
        id: str,
        instance_template_patch: 'InstanceTemplatePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceTemplate> updateInstanceTemplate(UpdateInstanceTemplateOptions updateInstanceTemplateOptions)
updateInstanceTemplate(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.template.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-template.instance-template.update

List all instances

This request lists all instances in the region.

This request lists all instances in the region.

This request lists all instances in the region.

This request lists all instances in the region.

This request lists all instances in the region.

GET /instances
(vpc *VpcV1) ListInstances(listInstancesOptions *ListInstancesOptions) (result *InstanceCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstancesWithContext(ctx context.Context, listInstancesOptions *ListInstancesOptions) (result *InstanceCollection, response *core.DetailedResponse, err error)
list_instances(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        name: Optional[str] = None,
        dedicated_host_id: Optional[str] = None,
        dedicated_host_crn: Optional[str] = None,
        dedicated_host_name: Optional[str] = None,
        placement_group_id: Optional[str] = None,
        placement_group_crn: Optional[str] = None,
        placement_group_name: Optional[str] = None,
        reservation_id: Optional[str] = None,
        reservation_crn: Optional[str] = None,
        reservation_name: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_crn: Optional[str] = None,
        vpc_name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceCollection> listInstances(ListInstancesOptions listInstancesOptions)
listInstances(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.instance.instance.list

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.instance.read

Create an instance

This request provisions a new instance from an instance prototype object. The prototype object is structured in the same way as a retrieved instance, and contains the information necessary to provision the new instance. The instance is automatically started.

This request provisions a new instance from an instance prototype object. The prototype object is structured in the same way as a retrieved instance, and contains the information necessary to provision the new instance. The instance is automatically started.

This request provisions a new instance from an instance prototype object. The prototype object is structured in the same way as a retrieved instance, and contains the information necessary to provision the new instance. The instance is automatically started.

This request provisions a new instance from an instance prototype object. The prototype object is structured in the same way as a retrieved instance, and contains the information necessary to provision the new instance. The instance is automatically started.

This request provisions a new instance from an instance prototype object. The prototype object is structured in the same way as a retrieved instance, and contains the information necessary to provision the new instance. The instance is automatically started.

POST /instances
(vpc *VpcV1) CreateInstance(createInstanceOptions *CreateInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceWithContext(ctx context.Context, createInstanceOptions *CreateInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)
create_instance(
        self,
        instance_prototype: 'InstancePrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Instance> createInstance(CreateInstanceOptions createInstanceOptions)
createInstance(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.create

  • is.instance.instance.ip-spoofing

    Required when allow_ip_spoofing is true on any instance network interface

  • is.subnet.subnet.operate

    Required for each subnet with an existing reserved IP being attached to an instance network interface or to a virtual network interface

  • is.subnet.subnet.update

  • is.reservation.reservation.operate

    Required when reservation_affinity.pools is specified.

  • is.volume.volume.create

    Required when image is specified, or boot_volume_attachment or volume_attachments specifies a new volume

  • is.volume.volume.operate

    Required when boot_volume_attachment or volume_attachments specifies an existing volume

  • is.security-group.security-group.operate

    Required for instance network interfaces, or for instance network attachments that specify a new virtual network interface

  • is.vpc.vpc.operate

  • is.key.key.operate

    Required when keys is specified

  • is.image.image.operate

    Required when image is specified

  • is.dedicated-host.dedicated-host-group.operate

    Required when placement_target specifies a dedicated host group

  • is.dedicated-host.dedicated-host.operate

    Required when placement_target specifies a dedicated host

  • is.snapshot.snapshot.operate

    Required when boot_volume_attachment or volume_attachments specifies a snapshot to create a new volume from.

  • is.placement-group.placement-group.operate

    Required when placement_target specifies a placement group

  • globalcatalog-collection.instance.retrieve

    Required when catalog_offering is specified

  • iam-identity.profile.get

    Required when default_trusted_profile.target specifies a trusted profile

  • iam-identity.profile.update

    Required when default_trusted_profile.auto_link is true

  • iam-identity.profile.linkToResource

    Required when default_trusted_profile.auto_link is true

  • is.virtual-network-interface.virtual-network-interface.create

    Required for instance network attachments that specify a new virtual network interface

  • is.virtual-network-interface.virtual-network-interface.manage-infrastructure-nat

    Required for instance network attachments that specify a new virtual network interface with enable_infrastructure_nat set to false

  • is.virtual-network-interface.virtual-network-interface.manage-ip-spoofing

    Required for instance network attachments that specify a new virtual network interface with allow_ip_spoofing set to true

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.instance.instance.create

  • is.instance.network-attachment.create

    Generated for each instance network attachment created

  • is.instance.network-interface.create

    Generated for each instance network interface created

  • is.instance.network-interface.attach

    Generated for each resource being attached to an instance network interface:

    • reserved IPs
    • security groups

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP being attached to:

    • an instance network interface, or
    • a virtual network interface

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created

  • is.security-group.security-group.attach

    Generated for each security group being attached to:

    • an instance network interface, or
    • a new virtual network interface

  • is.subnet.subnet.update

    Generated for each reserved IP created

  • is.virtual-network-interface.virtual-network-interface.create

    Generated for each virtual network interface created

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated for:

    • each virtual network interface being attached to an instance network attachment
    • each virtual network interface for each reserved IP being attached to it
    • each virtual network interface for each security group being attached to it

  • is.instance.network-attachment.attach

    Generated for each virtual network interface being attached to an instance network attachment

Delete an instance

This request deletes an instance. This operation cannot be reversed. Any floating IPs associated with instance network interfaces are implicitly disassociated. All virtual network interfaces with auto_delete set to true targeting instance network attachments on the instance are automatically deleted. All flow log collectors with auto_delete set to true targeting the instance, the instance network attachments, the instance network interfaces, or the automatically deleted virtual network interfaces are automatically deleted.

This request deletes an instance. This operation cannot be reversed. Any floating IPs associated with instance network interfaces are implicitly disassociated. All virtual network interfaces with auto_delete set to true targeting instance network attachments on the instance are automatically deleted. All flow log collectors with auto_delete set to true targeting the instance, the instance network attachments, the instance network interfaces, or the automatically deleted virtual network interfaces are automatically deleted.

This request deletes an instance. This operation cannot be reversed. Any floating IPs associated with instance network interfaces are implicitly disassociated. All virtual network interfaces with auto_delete set to true targeting instance network attachments on the instance are automatically deleted. All flow log collectors with auto_delete set to true targeting the instance, the instance network attachments, the instance network interfaces, or the automatically deleted virtual network interfaces are automatically deleted.

This request deletes an instance. This operation cannot be reversed. Any floating IPs associated with instance network interfaces are implicitly disassociated. All virtual network interfaces with auto_delete set to true targeting instance network attachments on the instance are automatically deleted. All flow log collectors with auto_delete set to true targeting the instance, the instance network attachments, the instance network interfaces, or the automatically deleted virtual network interfaces are automatically deleted.

This request deletes an instance. This operation cannot be reversed. Any floating IPs associated with instance network interfaces are implicitly disassociated. All virtual network interfaces with auto_delete set to true targeting instance network attachments on the instance are automatically deleted. All flow log collectors with auto_delete set to true targeting the instance, the instance network attachments, the instance network interfaces, or the automatically deleted virtual network interfaces are automatically deleted.

DELETE /instances/{id}
(vpc *VpcV1) DeleteInstance(deleteInstanceOptions *DeleteInstanceOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceWithContext(ctx context.Context, deleteInstanceOptions *DeleteInstanceOptions) (response *core.DetailedResponse, err error)
delete_instance(
        self,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstance(DeleteInstanceOptions deleteInstanceOptions)
deleteInstance(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.instance.instance.delete

  • is.instance.network-attachment.delete

    Generated for each network attachment on the instance

  • is.instance.network-attachment.detach

    Generated for each network attachment on the instance

  • is.instance.network-interface.delete

    Generated for each network interface on the instance

  • is.instance.network-interface.detach

    Generated for each resource attached to a network interface on the instance:

    • reserved IPs
    • security groups

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP that was attached to:

    • a network interface on the instance, or
    • a virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP that had auto_delete set to true that was attached to:

    • a network interface on the instance, or
    • a virtual network interface that had auto_delete set to true

  • is.security-group.security-group.detach

    Generated for each security group that was attached to:

    • a network interface on the instance, or
    • a virtual network interface that had auto_delete set to true

  • is.subnet.subnet.update

    Generated for each reserved IP that had auto_delete set to true

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated for:

    • each attached virtual network interface
    • each virtual network interface that had auto_delete set to true, for each attached reserved IP

  • is.virtual-network-interface.virtual-network-interface.delete

    Generated for each virtual network interface that had auto_delete set to true

  • is.floating-ip.floating-ip.detach

    Generated for each floating IP that was attached to:

    • a network interface on the instance, or
    • a virtual network interface that had auto_delete set to true

  • is.flow-log-collector.flow-log-collector.delete

    Generated for each flow log collector that had auto_delete set to true that was attached to:

    • the instance
    • a network interface on the instance
    • a network attachment on the instance
    • a virtual network interface that had auto_delete set to true

  • is.flow-log-collector.flow-log-collector.detach

    Generated for each flow log collector that was attached to:

    • the instance
    • a network interface on the instance
    • a network attachment on the instance
    • a virtual network interface that had auto_delete set to true

Retrieve an instance

This request retrieves a single instance specified by the identifier in the URL.

This request retrieves a single instance specified by the identifier in the URL.

This request retrieves a single instance specified by the identifier in the URL.

This request retrieves a single instance specified by the identifier in the URL.

This request retrieves a single instance specified by the identifier in the URL.

GET /instances/{id}
(vpc *VpcV1) GetInstance(getInstanceOptions *GetInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceWithContext(ctx context.Context, getInstanceOptions *GetInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)
get_instance(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Instance> getInstance(GetInstanceOptions getInstanceOptions)
getInstance(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.instance.read

Update an instance

This request updates an instance with the information in a provided instance patch. The instance patch object is structured in the same way as a retrieved instance and contains only the information to be updated.

This request updates an instance with the information in a provided instance patch. The instance patch object is structured in the same way as a retrieved instance and contains only the information to be updated.

This request updates an instance with the information in a provided instance patch. The instance patch object is structured in the same way as a retrieved instance and contains only the information to be updated.

This request updates an instance with the information in a provided instance patch. The instance patch object is structured in the same way as a retrieved instance and contains only the information to be updated.

This request updates an instance with the information in a provided instance patch. The instance patch object is structured in the same way as a retrieved instance and contains only the information to be updated.

PATCH /instances/{id}
(vpc *VpcV1) UpdateInstance(updateInstanceOptions *UpdateInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceWithContext(ctx context.Context, updateInstanceOptions *UpdateInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)
update_instance(
        self,
        id: str,
        instance_patch: 'InstancePatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Instance> updateInstance(UpdateInstanceOptions updateInstanceOptions)
updateInstance(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

  • is.reservation.reservation.operate

    Required when reservation_affinity.pools is specified.

  • is.dedicated-host.dedicated-host-group.operate

    Required when placement_target specifies a dedicated host group, or the placement target being replaced is a dedicated host group.

  • is.dedicated-host.dedicated-host.operate

    Required when placement_target specifies a dedicated host, or the placement target being replaced is a dedicated host.

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.instance.instance.update

  • is.instance.instance.detach

    Generated for each reservation being removed from reservation_affinity.pool.

  • is.reservation.reservation.detach

    Generated for each reservation being removed from reservation_affinity.pool.

  • is.instance.instance.attach

    Generated for each reservation being added to reservation_affinity.pool.

  • is.reservation.reservation.attach

    Generated for each reservation being added to reservation_affinity.pool.

Retrieve initialization configuration for an instance

This request retrieves configuration used to initialize the instance, such as SSH keys and the Windows administrator password. These can subsequently be changed on the instance and therefore may not be current.

This request retrieves configuration used to initialize the instance, such as SSH keys and the Windows administrator password. These can subsequently be changed on the instance and therefore may not be current.

This request retrieves configuration used to initialize the instance, such as SSH keys and the Windows administrator password. These can subsequently be changed on the instance and therefore may not be current.

This request retrieves configuration used to initialize the instance, such as SSH keys and the Windows administrator password. These can subsequently be changed on the instance and therefore may not be current.

This request retrieves configuration used to initialize the instance, such as SSH keys and the Windows administrator password. These can subsequently be changed on the instance and therefore may not be current.

GET /instances/{id}/initialization
(vpc *VpcV1) GetInstanceInitialization(getInstanceInitializationOptions *GetInstanceInitializationOptions) (result *InstanceInitialization, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceInitializationWithContext(ctx context.Context, getInstanceInitializationOptions *GetInstanceInitializationOptions) (result *InstanceInitialization, response *core.DetailedResponse, err error)
get_instance_initialization(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceInitialization> getInstanceInitialization(GetInstanceInitializationOptions getInstanceInitializationOptions)
getInstanceInitialization(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Create an instance action

This request creates a new action which will be queued up to run as soon as any pending or running actions have completed.

This request creates a new action which will be queued up to run as soon as any pending or running actions have completed.

This request creates a new action which will be queued up to run as soon as any pending or running actions have completed.

This request creates a new action which will be queued up to run as soon as any pending or running actions have completed.

This request creates a new action which will be queued up to run as soon as any pending or running actions have completed.

POST /instances/{instance_id}/actions
(vpc *VpcV1) CreateInstanceAction(createInstanceActionOptions *CreateInstanceActionOptions) (result *InstanceAction, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceActionWithContext(ctx context.Context, createInstanceActionOptions *CreateInstanceActionOptions) (result *InstanceAction, response *core.DetailedResponse, err error)
create_instance_action(
        self,
        instance_id: str,
        type: str,
        *,
        force: Optional[bool] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceAction> createInstanceAction(CreateInstanceActionOptions createInstanceActionOptions)
createInstanceAction(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.operate

Auditing

Calling this method generates the following auditing event.

  • is.instance.action.create

Retrieve the console WebSocket for an instance

This retrieves a WebSocket providing a console for the instance. An access_token must first be created using the console_access_token API. The serial WebSocket provides a TTY based interface. The vnc WebSocket provides a VNC based graphical interface.

GET /instances/{instance_id}/console

Auditing

Calling this method generates the following auditing event.

  • is.instance.console.read

Create a console access token for an instance

This request creates a new single-use console access token for an instance. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given instance at a time.

This request creates a new single-use console access token for an instance. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given instance at a time.

This request creates a new single-use console access token for an instance. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given instance at a time.

This request creates a new single-use console access token for an instance. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given instance at a time.

This request creates a new single-use console access token for an instance. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given instance at a time.

POST /instances/{instance_id}/console_access_token
(vpc *VpcV1) CreateInstanceConsoleAccessToken(createInstanceConsoleAccessTokenOptions *CreateInstanceConsoleAccessTokenOptions) (result *InstanceConsoleAccessToken, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceConsoleAccessTokenWithContext(ctx context.Context, createInstanceConsoleAccessTokenOptions *CreateInstanceConsoleAccessTokenOptions) (result *InstanceConsoleAccessToken, response *core.DetailedResponse, err error)
create_instance_console_access_token(
        self,
        instance_id: str,
        console_type: str,
        *,
        force: Optional[bool] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceConsoleAccessToken> createInstanceConsoleAccessToken(CreateInstanceConsoleAccessTokenOptions createInstanceConsoleAccessTokenOptions)
createInstanceConsoleAccessToken(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.instance.instance.operate

  • is.instance.instance.console

Auditing

Calling this method generates the following auditing event.

  • is.instance.console-access-token.create

List all disks on an instance

This request lists all disks on an instance. A disk is a block device that is locally attached to the instance's physical host and is also referred to as instance storage. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on an instance. A disk is a block device that is locally attached to the instance's physical host and is also referred to as instance storage. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on an instance. A disk is a block device that is locally attached to the instance's physical host and is also referred to as instance storage. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on an instance. A disk is a block device that is locally attached to the instance's physical host and is also referred to as instance storage. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on an instance. A disk is a block device that is locally attached to the instance's physical host and is also referred to as instance storage. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

GET /instances/{instance_id}/disks
(vpc *VpcV1) ListInstanceDisks(listInstanceDisksOptions *ListInstanceDisksOptions) (result *InstanceDiskCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceDisksWithContext(ctx context.Context, listInstanceDisksOptions *ListInstanceDisksOptions) (result *InstanceDiskCollection, response *core.DetailedResponse, err error)
list_instance_disks(
        self,
        instance_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceDiskCollection> listInstanceDisks(ListInstanceDisksOptions listInstanceDisksOptions)
listInstanceDisks(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.disk.read

Retrieve an instance disk

This request retrieves a single instance disk specified by the identifier in the URL.

This request retrieves a single instance disk specified by the identifier in the URL.

This request retrieves a single instance disk specified by the identifier in the URL.

This request retrieves a single instance disk specified by the identifier in the URL.

This request retrieves a single instance disk specified by the identifier in the URL.

GET /instances/{instance_id}/disks/{id}
(vpc *VpcV1) GetInstanceDisk(getInstanceDiskOptions *GetInstanceDiskOptions) (result *InstanceDisk, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceDiskWithContext(ctx context.Context, getInstanceDiskOptions *GetInstanceDiskOptions) (result *InstanceDisk, response *core.DetailedResponse, err error)
get_instance_disk(
        self,
        instance_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceDisk> getInstanceDisk(GetInstanceDiskOptions getInstanceDiskOptions)
getInstanceDisk(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.disk.read

Update an instance disk

This request updates the instance disk with the information in a provided patch.

This request updates the instance disk with the information in a provided patch.

This request updates the instance disk with the information in a provided patch.

This request updates the instance disk with the information in a provided patch.

This request updates the instance disk with the information in a provided patch.

PATCH /instances/{instance_id}/disks/{id}
(vpc *VpcV1) UpdateInstanceDisk(updateInstanceDiskOptions *UpdateInstanceDiskOptions) (result *InstanceDisk, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceDiskWithContext(ctx context.Context, updateInstanceDiskOptions *UpdateInstanceDiskOptions) (result *InstanceDisk, response *core.DetailedResponse, err error)
update_instance_disk(
        self,
        instance_id: str,
        id: str,
        instance_disk_patch: 'InstanceDiskPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceDisk> updateInstanceDisk(UpdateInstanceDiskOptions updateInstanceDiskOptions)
updateInstanceDisk(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

Auditing

Calling this method generates the following auditing event.

  • is.instance.disk.update

List all network attachments on an instance

This request lists all network attachments on an instance. A network attachment represents a device on the instance to which a virtual network interface is attached.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all network attachments on an instance. A network attachment represents a device on the instance to which a virtual network interface is attached.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all network attachments on an instance. A network attachment represents a device on the instance to which a virtual network interface is attached.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all network attachments on an instance. A network attachment represents a device on the instance to which a virtual network interface is attached.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all network attachments on an instance. A network attachment represents a device on the instance to which a virtual network interface is attached.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

GET /instances/{instance_id}/network_attachments
(vpc *VpcV1) ListInstanceNetworkAttachments(listInstanceNetworkAttachmentsOptions *ListInstanceNetworkAttachmentsOptions) (result *InstanceNetworkAttachmentCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceNetworkAttachmentsWithContext(ctx context.Context, listInstanceNetworkAttachmentsOptions *ListInstanceNetworkAttachmentsOptions) (result *InstanceNetworkAttachmentCollection, response *core.DetailedResponse, err error)
list_instance_network_attachments(
        self,
        instance_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceNetworkAttachmentCollection> listInstanceNetworkAttachments(ListInstanceNetworkAttachmentsOptions listInstanceNetworkAttachmentsOptions)
listInstanceNetworkAttachments(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.network-attachment.read

Create a network attachment on an instance

This request creates a new instance network attachment from an instance network attachment prototype object. The prototype object is structured in the same way as a retrieved instance network attachment, and contains the information necessary to create the new instance network attachment.

This request creates a new instance network attachment from an instance network attachment prototype object. The prototype object is structured in the same way as a retrieved instance network attachment, and contains the information necessary to create the new instance network attachment.

This request creates a new instance network attachment from an instance network attachment prototype object. The prototype object is structured in the same way as a retrieved instance network attachment, and contains the information necessary to create the new instance network attachment.

This request creates a new instance network attachment from an instance network attachment prototype object. The prototype object is structured in the same way as a retrieved instance network attachment, and contains the information necessary to create the new instance network attachment.

This request creates a new instance network attachment from an instance network attachment prototype object. The prototype object is structured in the same way as a retrieved instance network attachment, and contains the information necessary to create the new instance network attachment.

POST /instances/{instance_id}/network_attachments
(vpc *VpcV1) CreateInstanceNetworkAttachment(createInstanceNetworkAttachmentOptions *CreateInstanceNetworkAttachmentOptions) (result *InstanceNetworkAttachment, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceNetworkAttachmentWithContext(ctx context.Context, createInstanceNetworkAttachmentOptions *CreateInstanceNetworkAttachmentOptions) (result *InstanceNetworkAttachment, response *core.DetailedResponse, err error)
create_instance_network_attachment(
        self,
        instance_id: str,
        virtual_network_interface: 'InstanceNetworkAttachmentPrototypeVirtualNetworkInterface',
        *,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceNetworkAttachment> createInstanceNetworkAttachment(CreateInstanceNetworkAttachmentOptions createInstanceNetworkAttachmentOptions)
createInstanceNetworkAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

  • is.security-group.security-group.operate

    Required for instance network attachments that specify a new virtual network interface

  • is.subnet.subnet.operate

    Required for instance network attachments that specify a new virtual network interface and an existing reserved IP on a subnet

  • is.subnet.subnet.update

    Required for instance network attachments that specify a new virtual network interface and a new reserved IP on a subnet

  • is.virtual-network-interface.virtual-network-interface.create

    Required for instance network attachments that specify a new virtual network interface

  • is.virtual-network-interface.virtual-network-interface.manage-infrastructure-nat

    Required for instance network attachments that specify a new virtual network interface with enable_infrastructure_nat set to false

  • is.virtual-network-interface.virtual-network-interface.manage-ip-spoofing

    Required for instance network attachments that specify a new virtual network interface with allow_ip_spoofing set to true

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.virtual-network-interface.virtual-network-interface.create

    Generated for each virtual network interface created

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated for:

    • each virtual network interface being attached to an instance network attachment
    • each virtual network interface for each reserved IP being attached to it
    • each virtual network interface for each security group being attached to it

  • is.instance.network-attachment.attach

    Generated for each virtual network interface being attached to an instance network attachment

  • is.instance.network-attachment.create

  • is.security-group.security-group.attach

    Generated for each security group being attached to a new virtual network interface

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created

  • is.subnet.subnet.update

    Generated for each reserved IP created

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP being attached to a virtual network interface

Delete an instance network attachment

This request deletes an instance network attachment. This operation cannot be reversed. Any floating IPs associated with the instance network attachment are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network attachment are automatically deleted. The primary instance network attachment is not allowed to be deleted.

This request deletes an instance network attachment. This operation cannot be reversed. Any floating IPs associated with the instance network attachment are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network attachment are automatically deleted. The primary instance network attachment is not allowed to be deleted.

This request deletes an instance network attachment. This operation cannot be reversed. Any floating IPs associated with the instance network attachment are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network attachment are automatically deleted. The primary instance network attachment is not allowed to be deleted.

This request deletes an instance network attachment. This operation cannot be reversed. Any floating IPs associated with the instance network attachment are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network attachment are automatically deleted. The primary instance network attachment is not allowed to be deleted.

This request deletes an instance network attachment. This operation cannot be reversed. Any floating IPs associated with the instance network attachment are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network attachment are automatically deleted. The primary instance network attachment is not allowed to be deleted.

DELETE /instances/{instance_id}/network_attachments/{id}
(vpc *VpcV1) DeleteInstanceNetworkAttachment(deleteInstanceNetworkAttachmentOptions *DeleteInstanceNetworkAttachmentOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceNetworkAttachmentWithContext(ctx context.Context, deleteInstanceNetworkAttachmentOptions *DeleteInstanceNetworkAttachmentOptions) (response *core.DetailedResponse, err error)
delete_instance_network_attachment(
        self,
        instance_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceNetworkAttachment(DeleteInstanceNetworkAttachmentOptions deleteInstanceNetworkAttachmentOptions)
deleteInstanceNetworkAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.instance.network-attachment.delete

  • is.instance.network-attachment.detach

    Generated for each resource that was attached to this instance network attachment:

    • a flow log collector
    • a virtual network interface

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated for the attached virtual network interface, and also for each reserved IP that was attached to the virtual network interface if the virtual network interface had auto_delete set to true

  • is.virtual-network-interface.virtual-network-interface.delete

    Generated when the virtual network interface had auto_delete set to true

  • is.floating-ip.floating-ip.detach

    Generated for each floating IP that was attached to a virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP that was attached to an virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP that had auto_delete set to true that was attached to a virtual network interface that had auto_delete set to true

  • is.subnet.subnet.update

    Generated for each reserved IP that had auto_delete set to true that was attached to a virtual network interface that had auto_delete set to true

  • is.security-group.security-group.detach

    Generated for each security group that was attached to a virtual network interface that had auto_delete set to true

  • is.flow-log-collector.flow-log-collector.delete

    Generated for each flow log collector that had auto_delete set to true that was attached to:

    • this instance network attachment
    • a virtual network interface that had auto_delete set to true

  • is.flow-log-collector.flow-log-collector.detach

    Generated for each flow log collector that was attached to:

    • this instance network attachment
    • a virtual network interface that had auto_delete set to true

Retrieve an instance network attachment

This request retrieves a single instance network attachment specified by the identifier in the URL.

This request retrieves a single instance network attachment specified by the identifier in the URL.

This request retrieves a single instance network attachment specified by the identifier in the URL.

This request retrieves a single instance network attachment specified by the identifier in the URL.

This request retrieves a single instance network attachment specified by the identifier in the URL.

GET /instances/{instance_id}/network_attachments/{id}
(vpc *VpcV1) GetInstanceNetworkAttachment(getInstanceNetworkAttachmentOptions *GetInstanceNetworkAttachmentOptions) (result *InstanceNetworkAttachment, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceNetworkAttachmentWithContext(ctx context.Context, getInstanceNetworkAttachmentOptions *GetInstanceNetworkAttachmentOptions) (result *InstanceNetworkAttachment, response *core.DetailedResponse, err error)
get_instance_network_attachment(
        self,
        instance_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceNetworkAttachment> getInstanceNetworkAttachment(GetInstanceNetworkAttachmentOptions getInstanceNetworkAttachmentOptions)
getInstanceNetworkAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.network-attachment.read

Update an instance network attachment

This request updates an instance network attachment with the information provided in an instance network interface patch object. The instance network attachment patch object is structured in the same way as a retrieved instance network attachment and needs to contain only the information to be updated.

This request updates an instance network attachment with the information provided in an instance network interface patch object. The instance network attachment patch object is structured in the same way as a retrieved instance network attachment and needs to contain only the information to be updated.

This request updates an instance network attachment with the information provided in an instance network interface patch object. The instance network attachment patch object is structured in the same way as a retrieved instance network attachment and needs to contain only the information to be updated.

This request updates an instance network attachment with the information provided in an instance network interface patch object. The instance network attachment patch object is structured in the same way as a retrieved instance network attachment and needs to contain only the information to be updated.

This request updates an instance network attachment with the information provided in an instance network interface patch object. The instance network attachment patch object is structured in the same way as a retrieved instance network attachment and needs to contain only the information to be updated.

PATCH /instances/{instance_id}/network_attachments/{id}
(vpc *VpcV1) UpdateInstanceNetworkAttachment(updateInstanceNetworkAttachmentOptions *UpdateInstanceNetworkAttachmentOptions) (result *InstanceNetworkAttachment, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceNetworkAttachmentWithContext(ctx context.Context, updateInstanceNetworkAttachmentOptions *UpdateInstanceNetworkAttachmentOptions) (result *InstanceNetworkAttachment, response *core.DetailedResponse, err error)
update_instance_network_attachment(
        self,
        instance_id: str,
        id: str,
        instance_network_attachment_patch: 'InstanceNetworkAttachmentPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceNetworkAttachment> updateInstanceNetworkAttachment(UpdateInstanceNetworkAttachmentOptions updateInstanceNetworkAttachmentOptions)
updateInstanceNetworkAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

Auditing

Calling this method generates the following auditing event.

  • is.instance.network-attachment.update

List all network interfaces on an instance

This request lists all network interfaces on an instance. An instance network interface is an abstract representation of a network device and attaches an instance to a single subnet. Each network interface on an instance can attach to any subnet in the zone, including subnets that are already attached to the instance. Multiple network interfaces on the instance may also attach to the same subnet.

If this instance has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request lists all network interfaces on an instance. An instance network interface is an abstract representation of a network device and attaches an instance to a single subnet. Each network interface on an instance can attach to any subnet in the zone, including subnets that are already attached to the instance. Multiple network interfaces on the instance may also attach to the same subnet.

If this instance has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request lists all network interfaces on an instance. An instance network interface is an abstract representation of a network device and attaches an instance to a single subnet. Each network interface on an instance can attach to any subnet in the zone, including subnets that are already attached to the instance. Multiple network interfaces on the instance may also attach to the same subnet.

If this instance has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request lists all network interfaces on an instance. An instance network interface is an abstract representation of a network device and attaches an instance to a single subnet. Each network interface on an instance can attach to any subnet in the zone, including subnets that are already attached to the instance. Multiple network interfaces on the instance may also attach to the same subnet.

If this instance has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request lists all network interfaces on an instance. An instance network interface is an abstract representation of a network device and attaches an instance to a single subnet. Each network interface on an instance can attach to any subnet in the zone, including subnets that are already attached to the instance. Multiple network interfaces on the instance may also attach to the same subnet.

If this instance has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

GET /instances/{instance_id}/network_interfaces
(vpc *VpcV1) ListInstanceNetworkInterfaces(listInstanceNetworkInterfacesOptions *ListInstanceNetworkInterfacesOptions) (result *NetworkInterfaceUnpaginatedCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceNetworkInterfacesWithContext(ctx context.Context, listInstanceNetworkInterfacesOptions *ListInstanceNetworkInterfacesOptions) (result *NetworkInterfaceUnpaginatedCollection, response *core.DetailedResponse, err error)
list_instance_network_interfaces(
        self,
        instance_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkInterfaceUnpaginatedCollection> listInstanceNetworkInterfaces(ListInstanceNetworkInterfacesOptions listInstanceNetworkInterfacesOptions)
listInstanceNetworkInterfaces(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.network-interface.read

Create a network interface on an instance

This request creates a new instance network interface from an instance network interface prototype object. The prototype object is structured in the same way as a retrieved instance network interface, and contains the information necessary to create the new instance network interface. Any subnet in the instance's VPC may be specified. Addresses on the instance network interface must be within the specified subnet's CIDR blocks.

If this instance has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

This request creates a new instance network interface from an instance network interface prototype object. The prototype object is structured in the same way as a retrieved instance network interface, and contains the information necessary to create the new instance network interface. Any subnet in the instance's VPC may be specified. Addresses on the instance network interface must be within the specified subnet's CIDR blocks.

If this instance has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

This request creates a new instance network interface from an instance network interface prototype object. The prototype object is structured in the same way as a retrieved instance network interface, and contains the information necessary to create the new instance network interface. Any subnet in the instance's VPC may be specified. Addresses on the instance network interface must be within the specified subnet's CIDR blocks.

If this instance has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

This request creates a new instance network interface from an instance network interface prototype object. The prototype object is structured in the same way as a retrieved instance network interface, and contains the information necessary to create the new instance network interface. Any subnet in the instance's VPC may be specified. Addresses on the instance network interface must be within the specified subnet's CIDR blocks.

If this instance has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

This request creates a new instance network interface from an instance network interface prototype object. The prototype object is structured in the same way as a retrieved instance network interface, and contains the information necessary to create the new instance network interface. Any subnet in the instance's VPC may be specified. Addresses on the instance network interface must be within the specified subnet's CIDR blocks.

If this instance has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

POST /instances/{instance_id}/network_interfaces
(vpc *VpcV1) CreateInstanceNetworkInterface(createInstanceNetworkInterfaceOptions *CreateInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceNetworkInterfaceWithContext(ctx context.Context, createInstanceNetworkInterfaceOptions *CreateInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error)
create_instance_network_interface(
        self,
        instance_id: str,
        subnet: 'SubnetIdentity',
        *,
        allow_ip_spoofing: Optional[bool] = None,
        name: Optional[str] = None,
        primary_ip: Optional['NetworkInterfaceIPPrototype'] = None,
        security_groups: Optional[List['SecurityGroupIdentity']] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkInterface> createInstanceNetworkInterface(CreateInstanceNetworkInterfaceOptions createInstanceNetworkInterfaceOptions)
createInstanceNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

  • is.instance.instance.ip-spoofing

    Required when allow_ip_spoofing is true

  • is.security-group.security-group.operate

  • is.subnet.subnet.operate

    Required for instance network interfaces that specify an existing reserved IP on a subnet

  • is.subnet.subnet.update

    Required for instance network interfaces that specify a new reserved IP on a subnet

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.instance.network-interface.create

  • is.instance.network-interface.attach

    Generated for each resource being attached to an instance network interface:

    • security groups
    • reserved IPs

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP being attached to an instance network interface

  • is.security-group.security-group.attach

    Generated for each security group being attached to an instance network interface

  • is.subnet.subnet.update

    Generated for each reserved IP created

Delete an instance network interface

This request deletes an instance network interface. This operation cannot be reversed. Any floating IPs associated with the instance network interface are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network interface are automatically deleted. The primary instance network interface is not allowed to be deleted.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

This request deletes an instance network interface. This operation cannot be reversed. Any floating IPs associated with the instance network interface are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network interface are automatically deleted. The primary instance network interface is not allowed to be deleted.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

This request deletes an instance network interface. This operation cannot be reversed. Any floating IPs associated with the instance network interface are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network interface are automatically deleted. The primary instance network interface is not allowed to be deleted.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

This request deletes an instance network interface. This operation cannot be reversed. Any floating IPs associated with the instance network interface are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network interface are automatically deleted. The primary instance network interface is not allowed to be deleted.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

This request deletes an instance network interface. This operation cannot be reversed. Any floating IPs associated with the instance network interface are implicitly disassociated. All flow log collectors with auto_delete set to true targeting the instance network interface are automatically deleted. The primary instance network interface is not allowed to be deleted.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

DELETE /instances/{instance_id}/network_interfaces/{id}
(vpc *VpcV1) DeleteInstanceNetworkInterface(deleteInstanceNetworkInterfaceOptions *DeleteInstanceNetworkInterfaceOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceNetworkInterfaceWithContext(ctx context.Context, deleteInstanceNetworkInterfaceOptions *DeleteInstanceNetworkInterfaceOptions) (response *core.DetailedResponse, err error)
delete_instance_network_interface(
        self,
        instance_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceNetworkInterface(DeleteInstanceNetworkInterfaceOptions deleteInstanceNetworkInterfaceOptions)
deleteInstanceNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.instance.network-interface.delete

  • is.instance.network-interface.detach

    Generated for each resource that was attached to this instance network interface:

    • a floating IP
    • a flow log collector
    • a reserved IP
    • security groups

  • is.floating-ip.floating-ip.detach

    Generated for each floating IP that was attached to this instance network interface

  • is.security-group.security-group.detach

    Generated for each security group that was attached to this instance network interface

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP that was attached to this instance network interface

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP that had auto_delete set to true that was attached to this instance network interface

  • is.subnet.subnet.update

    Generated for each reserved IP that had auto_delete set to true that was attached to this instance network interface

  • is.flow-log-collector.flow-log-collector.delete

    Generated for each flow log collector that had auto_delete set to true that was attached to this instance network interface

  • is.flow-log-collector.flow-log-collector.detach

    Generated for each flow log collector that was attached to this instance network interface

Retrieve an instance network interface

This request retrieves a single instance network interface specified by the identifier in the URL.

If this instance has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request retrieves a single instance network interface specified by the identifier in the URL.

If this instance has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request retrieves a single instance network interface specified by the identifier in the URL.

If this instance has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request retrieves a single instance network interface specified by the identifier in the URL.

If this instance has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request retrieves a single instance network interface specified by the identifier in the URL.

If this instance has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

GET /instances/{instance_id}/network_interfaces/{id}
(vpc *VpcV1) GetInstanceNetworkInterface(getInstanceNetworkInterfaceOptions *GetInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceNetworkInterfaceWithContext(ctx context.Context, getInstanceNetworkInterfaceOptions *GetInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error)
get_instance_network_interface(
        self,
        instance_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkInterface> getInstanceNetworkInterface(GetInstanceNetworkInterfaceOptions getInstanceNetworkInterfaceOptions)
getInstanceNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.network-interface.read

Update an instance network interface

This request updates an instance network interface with the information provided in an instance network interface patch object. The instance network interface patch object is structured in the same way as a retrieved instance network interface and needs to contain only the information to be updated.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

This request updates an instance network interface with the information provided in an instance network interface patch object. The instance network interface patch object is structured in the same way as a retrieved instance network interface and needs to contain only the information to be updated.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

This request updates an instance network interface with the information provided in an instance network interface patch object. The instance network interface patch object is structured in the same way as a retrieved instance network interface and needs to contain only the information to be updated.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

This request updates an instance network interface with the information provided in an instance network interface patch object. The instance network interface patch object is structured in the same way as a retrieved instance network interface and needs to contain only the information to be updated.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

This request updates an instance network interface with the information provided in an instance network interface patch object. The instance network interface patch object is structured in the same way as a retrieved instance network interface and needs to contain only the information to be updated.

If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

PATCH /instances/{instance_id}/network_interfaces/{id}
(vpc *VpcV1) UpdateInstanceNetworkInterface(updateInstanceNetworkInterfaceOptions *UpdateInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceNetworkInterfaceWithContext(ctx context.Context, updateInstanceNetworkInterfaceOptions *UpdateInstanceNetworkInterfaceOptions) (result *NetworkInterface, response *core.DetailedResponse, err error)
update_instance_network_interface(
        self,
        instance_id: str,
        id: str,
        network_interface_patch: 'NetworkInterfacePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkInterface> updateInstanceNetworkInterface(UpdateInstanceNetworkInterfaceOptions updateInstanceNetworkInterfaceOptions)
updateInstanceNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

  • is.instance.instance.ip-spoofing

    Required when allow_ip_spoofing is true

Auditing

Calling this method generates the following auditing event.

  • is.instance.network-interface.update

List all floating IPs associated with an instance network interface

This request lists all floating IPs associated with an instance network interface.

This request lists all floating IPs associated with an instance network interface.

This request lists all floating IPs associated with an instance network interface.

This request lists all floating IPs associated with an instance network interface.

This request lists all floating IPs associated with an instance network interface.

GET /instances/{instance_id}/network_interfaces/{network_interface_id}/floating_ips
(vpc *VpcV1) ListInstanceNetworkInterfaceFloatingIps(listInstanceNetworkInterfaceFloatingIpsOptions *ListInstanceNetworkInterfaceFloatingIpsOptions) (result *FloatingIPUnpaginatedCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceNetworkInterfaceFloatingIpsWithContext(ctx context.Context, listInstanceNetworkInterfaceFloatingIpsOptions *ListInstanceNetworkInterfaceFloatingIpsOptions) (result *FloatingIPUnpaginatedCollection, response *core.DetailedResponse, err error)
list_instance_network_interface_floating_ips(
        self,
        instance_id: str,
        network_interface_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIPUnpaginatedCollection> listInstanceNetworkInterfaceFloatingIps(ListInstanceNetworkInterfaceFloatingIpsOptions listInstanceNetworkInterfaceFloatingIpsOptions)
listInstanceNetworkInterfaceFloatingIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

  • is.floating-ip.floating-ip.read

    Required for all floating IPs associated with the instance network interface

Auditing

Calling this method generates the following auditing event.

  • is.instance.network-interface_floating-ip.read

Disassociate a floating IP from an instance network interface

This request disassociates the specified floating IP from the specified instance network interface

This request disassociates the specified floating IP from the specified instance network interface.

This request disassociates the specified floating IP from the specified instance network interface.

This request disassociates the specified floating IP from the specified instance network interface.

This request disassociates the specified floating IP from the specified instance network interface.

DELETE /instances/{instance_id}/network_interfaces/{network_interface_id}/floating_ips/{id}
(vpc *VpcV1) RemoveInstanceNetworkInterfaceFloatingIP(removeInstanceNetworkInterfaceFloatingIPOptions *RemoveInstanceNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) RemoveInstanceNetworkInterfaceFloatingIPWithContext(ctx context.Context, removeInstanceNetworkInterfaceFloatingIPOptions *RemoveInstanceNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error)
remove_instance_network_interface_floating_ip(
        self,
        instance_id: str,
        network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> removeInstanceNetworkInterfaceFloatingIp(RemoveInstanceNetworkInterfaceFloatingIpOptions removeInstanceNetworkInterfaceFloatingIpOptions)
removeInstanceNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.instance.instance.operate

  • is.floating-ip.floating-ip.operate

Auditing

Calling this method generates the following auditing events.

  • is.instance.network-interface.detach

  • is.floating-ip.floating-ip.detach

Retrieve associated floating IP

This request retrieves a specified floating IP address if it is associated with the instance network interface and instance specified in the URL

This request retrieves a specified floating IP address if it is associated with the instance network interface and instance specified in the URL.

This request retrieves a specified floating IP address if it is associated with the instance network interface and instance specified in the URL.

This request retrieves a specified floating IP address if it is associated with the instance network interface and instance specified in the URL.

This request retrieves a specified floating IP address if it is associated with the instance network interface and instance specified in the URL.

GET /instances/{instance_id}/network_interfaces/{network_interface_id}/floating_ips/{id}
(vpc *VpcV1) GetInstanceNetworkInterfaceFloatingIP(getInstanceNetworkInterfaceFloatingIPOptions *GetInstanceNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceNetworkInterfaceFloatingIPWithContext(ctx context.Context, getInstanceNetworkInterfaceFloatingIPOptions *GetInstanceNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
get_instance_network_interface_floating_ip(
        self,
        instance_id: str,
        network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIP> getInstanceNetworkInterfaceFloatingIp(GetInstanceNetworkInterfaceFloatingIpOptions getInstanceNetworkInterfaceFloatingIpOptions)
getInstanceNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

  • is.floating-ip.floating-ip.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.network-interface_floating-ip.read

Associate a floating IP with an instance network interface

This request associates the specified floating IP with the specified instance network interface, replacing any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the instance

A request body is not required, and if provided, is ignored.

This request associates the specified floating IP with the specified instance network interface, replacing any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the instance

A request body is not required, and if provided, is ignored.

This request associates the specified floating IP with the specified instance network interface, replacing any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the instance

A request body is not required, and if provided, is ignored.

This request associates the specified floating IP with the specified instance network interface, replacing any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the instance

A request body is not required, and if provided, is ignored.

This request associates the specified floating IP with the specified instance network interface, replacing any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the instance

A request body is not required, and if provided, is ignored.

PUT /instances/{instance_id}/network_interfaces/{network_interface_id}/floating_ips/{id}
(vpc *VpcV1) AddInstanceNetworkInterfaceFloatingIP(addInstanceNetworkInterfaceFloatingIPOptions *AddInstanceNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) AddInstanceNetworkInterfaceFloatingIPWithContext(ctx context.Context, addInstanceNetworkInterfaceFloatingIPOptions *AddInstanceNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
add_instance_network_interface_floating_ip(
        self,
        instance_id: str,
        network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIP> addInstanceNetworkInterfaceFloatingIp(AddInstanceNetworkInterfaceFloatingIpOptions addInstanceNetworkInterfaceFloatingIpOptions)
addInstanceNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.operate

    Required for the instance associated with the specified instance network interface, and for the instance associated with the instance network interface being replaced (if any).

  • is.floating-ip.floating-ip.operate

Auditing

Calling this method generates the following auditing events.

  • is.instance.network-interface.attach

  • is.floating-ip.floating-ip.attach

List the primary reserved IP for an instance network interface

This request lists the primary reserved IP for an instance network interface.

This request lists the primary reserved IP for an instance network interface.

This request lists the primary reserved IP for an instance network interface.

This request lists the primary reserved IP for an instance network interface.

This request lists the primary reserved IP for an instance network interface.

GET /instances/{instance_id}/network_interfaces/{network_interface_id}/ips
(vpc *VpcV1) ListInstanceNetworkInterfaceIps(listInstanceNetworkInterfaceIpsOptions *ListInstanceNetworkInterfaceIpsOptions) (result *ReservedIPCollectionInstanceNetworkInterfaceContext, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceNetworkInterfaceIpsWithContext(ctx context.Context, listInstanceNetworkInterfaceIpsOptions *ListInstanceNetworkInterfaceIpsOptions) (result *ReservedIPCollectionInstanceNetworkInterfaceContext, response *core.DetailedResponse, err error)
list_instance_network_interface_ips(
        self,
        instance_id: str,
        network_interface_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIPCollectionInstanceNetworkInterfaceContext> listInstanceNetworkInterfaceIps(ListInstanceNetworkInterfaceIpsOptions listInstanceNetworkInterfaceIpsOptions)
listInstanceNetworkInterfaceIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

  • is.subnet.subnet.read

    Required for the subnet attached to the instance network interface

Auditing

Calling this method generates the following auditing event, depending on any listed conditions.

  • is.subnet.reserved-ip.read

    Generated for each reserved IP in the list.

Retrieve the primary reserved IP

This request retrieves the primary reserved IP for an instance network interface.

This request retrieves the primary reserved IP for an instance network interface.

This request retrieves the primary reserved IP for an instance network interface.

This request retrieves the primary reserved IP for an instance network interface.

This request retrieves the primary reserved IP for an instance network interface.

GET /instances/{instance_id}/network_interfaces/{network_interface_id}/ips/{id}
(vpc *VpcV1) GetInstanceNetworkInterfaceIP(getInstanceNetworkInterfaceIPOptions *GetInstanceNetworkInterfaceIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceNetworkInterfaceIPWithContext(ctx context.Context, getInstanceNetworkInterfaceIPOptions *GetInstanceNetworkInterfaceIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
get_instance_network_interface_ip(
        self,
        instance_id: str,
        network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIP> getInstanceNetworkInterfaceIp(GetInstanceNetworkInterfaceIpOptions getInstanceNetworkInterfaceIpOptions)
getInstanceNetworkInterfaceIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

  • is.subnet.subnet.read

    Required for the subnet attached to the instance network interface

Auditing

Calling this method generates the following auditing event.

  • is.subnet.reserved-ip.read

List all volumes attachments on an instance

This request lists all volume attachments on an instance. A volume attachment connects a volume to an instance. Each instance may have many volume attachments but each volume attachment connects exactly one instance to exactly one volume.

This request lists all volume attachments on an instance. A volume attachment connects a volume to an instance. Each instance may have many volume attachments but each volume attachment connects exactly one instance to exactly one volume.

This request lists all volume attachments on an instance. A volume attachment connects a volume to an instance. Each instance may have many volume attachments but each volume attachment connects exactly one instance to exactly one volume.

This request lists all volume attachments on an instance. A volume attachment connects a volume to an instance. Each instance may have many volume attachments but each volume attachment connects exactly one instance to exactly one volume.

This request lists all volume attachments on an instance. A volume attachment connects a volume to an instance. Each instance may have many volume attachments but each volume attachment connects exactly one instance to exactly one volume.

GET /instances/{instance_id}/volume_attachments
(vpc *VpcV1) ListInstanceVolumeAttachments(listInstanceVolumeAttachmentsOptions *ListInstanceVolumeAttachmentsOptions) (result *VolumeAttachmentCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceVolumeAttachmentsWithContext(ctx context.Context, listInstanceVolumeAttachmentsOptions *ListInstanceVolumeAttachmentsOptions) (result *VolumeAttachmentCollection, response *core.DetailedResponse, err error)
list_instance_volume_attachments(
        self,
        instance_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VolumeAttachmentCollection> listInstanceVolumeAttachments(ListInstanceVolumeAttachmentsOptions listInstanceVolumeAttachmentsOptions)
listInstanceVolumeAttachments(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.volume-attachment.read

Create a volume attachment on an instance

This request creates a new volume attachment from a volume attachment prototype object, connecting a volume to an instance. For this request to succeed, the specified volume must not be busy. The prototype object is structured in the same way as a retrieved volume attachment, and contains the information necessary to create the new volume attachment.

This request creates a new volume attachment from a volume attachment prototype object, connecting a volume to an instance. For this request to succeed, the specified volume must not be busy. The prototype object is structured in the same way as a retrieved volume attachment, and contains the information necessary to create the new volume attachment.

This request creates a new volume attachment from a volume attachment prototype object, connecting a volume to an instance. For this request to succeed, the specified volume must not be busy. The prototype object is structured in the same way as a retrieved volume attachment, and contains the information necessary to create the new volume attachment.

This request creates a new volume attachment from a volume attachment prototype object, connecting a volume to an instance. For this request to succeed, the specified volume must not be busy. The prototype object is structured in the same way as a retrieved volume attachment, and contains the information necessary to create the new volume attachment.

This request creates a new volume attachment from a volume attachment prototype object, connecting a volume to an instance. For this request to succeed, the specified volume must not be busy. The prototype object is structured in the same way as a retrieved volume attachment, and contains the information necessary to create the new volume attachment.

POST /instances/{instance_id}/volume_attachments
(vpc *VpcV1) CreateInstanceVolumeAttachment(createInstanceVolumeAttachmentOptions *CreateInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceVolumeAttachmentWithContext(ctx context.Context, createInstanceVolumeAttachmentOptions *CreateInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error)
create_instance_volume_attachment(
        self,
        instance_id: str,
        volume: 'VolumeAttachmentPrototypeVolume',
        *,
        delete_volume_on_instance_delete: Optional[bool] = None,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VolumeAttachment> createInstanceVolumeAttachment(CreateInstanceVolumeAttachmentOptions createInstanceVolumeAttachmentOptions)
createInstanceVolumeAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

  • is.volume.volume.operate

    Required when volume specifies an existing volume

  • is.volume.volume.create

    Required when volume specifies a new volume

  • is.snapshot.snapshot.operate

    Required when volume specifies a snapshot to create a new volume from

Auditing

Calling this method generates the following auditing event.

  • is.instance.volume-attachment.create

Delete a volume attachment

This request deletes a volume attachment. This operation cannot be reversed, but a new volume attachment may subsequently be created for the volume. For this request to succeed, the volume must not be busy.

This request deletes a volume attachment. This operation cannot be reversed, but a new volume attachment may subsequently be created for the volume. For this request to succeed, the volume must not be busy.

This request deletes a volume attachment. This operation cannot be reversed, but a new volume attachment may subsequently be created for the volume. For this request to succeed, the volume must not be busy.

This request deletes a volume attachment. This operation cannot be reversed, but a new volume attachment may subsequently be created for the volume. For this request to succeed, the volume must not be busy.

This request deletes a volume attachment. This operation cannot be reversed, but a new volume attachment may subsequently be created for the volume. For this request to succeed, the volume must not be busy.

DELETE /instances/{instance_id}/volume_attachments/{id}
(vpc *VpcV1) DeleteInstanceVolumeAttachment(deleteInstanceVolumeAttachmentOptions *DeleteInstanceVolumeAttachmentOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceVolumeAttachmentWithContext(ctx context.Context, deleteInstanceVolumeAttachmentOptions *DeleteInstanceVolumeAttachmentOptions) (response *core.DetailedResponse, err error)
delete_instance_volume_attachment(
        self,
        instance_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceVolumeAttachment(DeleteInstanceVolumeAttachmentOptions deleteInstanceVolumeAttachmentOptions)
deleteInstanceVolumeAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.instance.instance.operate

  • is.volume.volume.operate

Auditing

Calling this method generates the following auditing event.

  • is.instance.volume-attachment.delete

Retrieve a volume attachment

This request retrieves a single volume attachment specified by the identifier in the URL.

This request retrieves a single volume attachment specified by the identifier in the URL.

This request retrieves a single volume attachment specified by the identifier in the URL.

This request retrieves a single volume attachment specified by the identifier in the URL.

This request retrieves a single volume attachment specified by the identifier in the URL.

GET /instances/{instance_id}/volume_attachments/{id}
(vpc *VpcV1) GetInstanceVolumeAttachment(getInstanceVolumeAttachmentOptions *GetInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceVolumeAttachmentWithContext(ctx context.Context, getInstanceVolumeAttachmentOptions *GetInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error)
get_instance_volume_attachment(
        self,
        instance_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VolumeAttachment> getInstanceVolumeAttachment(GetInstanceVolumeAttachmentOptions getInstanceVolumeAttachmentOptions)
getInstanceVolumeAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.read

Auditing

Calling this method generates the following auditing event.

  • is.instance.volume-attachment.read

Update a volume attachment

This request updates a volume attachment with the information provided in a volume attachment patch object. The volume attachment patch object is structured in the same way as a retrieved volume attachment and needs to contain only the information to be updated.

This request updates a volume attachment with the information provided in a volume attachment patch object. The volume attachment patch object is structured in the same way as a retrieved volume attachment and needs to contain only the information to be updated.

This request updates a volume attachment with the information provided in a volume attachment patch object. The volume attachment patch object is structured in the same way as a retrieved volume attachment and needs to contain only the information to be updated.

This request updates a volume attachment with the information provided in a volume attachment patch object. The volume attachment patch object is structured in the same way as a retrieved volume attachment and needs to contain only the information to be updated.

This request updates a volume attachment with the information provided in a volume attachment patch object. The volume attachment patch object is structured in the same way as a retrieved volume attachment and needs to contain only the information to be updated.

PATCH /instances/{instance_id}/volume_attachments/{id}
(vpc *VpcV1) UpdateInstanceVolumeAttachment(updateInstanceVolumeAttachmentOptions *UpdateInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceVolumeAttachmentWithContext(ctx context.Context, updateInstanceVolumeAttachmentOptions *UpdateInstanceVolumeAttachmentOptions) (result *VolumeAttachment, response *core.DetailedResponse, err error)
update_instance_volume_attachment(
        self,
        instance_id: str,
        id: str,
        volume_attachment_patch: 'VolumeAttachmentPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VolumeAttachment> updateInstanceVolumeAttachment(UpdateInstanceVolumeAttachmentOptions updateInstanceVolumeAttachmentOptions)
updateInstanceVolumeAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance.instance.update

Auditing

Calling this method generates the following auditing event.

  • is.instance.volume-attachment.update

List all instance groups

This request lists all instance groups in the region.

This request lists all instance groups in the region.

This request lists all instance groups in the region.

This request lists all instance groups in the region.

This request lists all instance groups in the region.

GET /instance_groups
(vpc *VpcV1) ListInstanceGroups(listInstanceGroupsOptions *ListInstanceGroupsOptions) (result *InstanceGroupCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceGroupsWithContext(ctx context.Context, listInstanceGroupsOptions *ListInstanceGroupsOptions) (result *InstanceGroupCollection, response *core.DetailedResponse, err error)
list_instance_groups(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupCollection> listInstanceGroups(ListInstanceGroupsOptions listInstanceGroupsOptions)
listInstanceGroups(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.list

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.instance-group.read

Create an instance group

This request creates a new instance group

This request creates a new instance group.

This request creates a new instance group.

This request creates a new instance group.

This request creates a new instance group.

POST /instance_groups
(vpc *VpcV1) CreateInstanceGroup(createInstanceGroupOptions *CreateInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceGroupWithContext(ctx context.Context, createInstanceGroupOptions *CreateInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error)
create_instance_group(
        self,
        instance_template: 'InstanceTemplateIdentity',
        subnets: List['SubnetIdentity'],
        *,
        application_port: Optional[int] = None,
        load_balancer: Optional['LoadBalancerIdentity'] = None,
        load_balancer_pool: Optional['LoadBalancerPoolIdentity'] = None,
        membership_count: Optional[int] = None,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroup> createInstanceGroup(CreateInstanceGroupOptions createInstanceGroupOptions)
createInstanceGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.create

  • is.instance.instance-template.read

  • is.subnet.subnet.operate

  • is.load-balancer.load-balancer.manage

    Required when load_balancer and/or load_balancer_pool is specified

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.instance-group.create

Delete an instance group

This request deletes an instance group. This operation cannot be reversed. Any instances associated with the group will be deleted.

This request deletes an instance group. This operation cannot be reversed. Any instances associated with the group will be deleted.

This request deletes an instance group. This operation cannot be reversed. Any instances associated with the group will be deleted.

This request deletes an instance group. This operation cannot be reversed. Any instances associated with the group will be deleted.

This request deletes an instance group. This operation cannot be reversed. Any instances associated with the group will be deleted.

DELETE /instance_groups/{id}
(vpc *VpcV1) DeleteInstanceGroup(deleteInstanceGroupOptions *DeleteInstanceGroupOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceGroupWithContext(ctx context.Context, deleteInstanceGroupOptions *DeleteInstanceGroupOptions) (response *core.DetailedResponse, err error)
delete_instance_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceGroup(DeleteInstanceGroupOptions deleteInstanceGroupOptions)
deleteInstanceGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.delete

  • is.instance.instance.delete

  • is.load-balancer.load-balancer.manage

    Required when the instance group manages a load balancer

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.instance-group.delete

Retrieve an instance group

This request retrieves a single instance group specified by identifier in the URL.

This request retrieves a single instance group specified by identifier in the URL.

This request retrieves a single instance group specified by identifier in the URL.

This request retrieves a single instance group specified by identifier in the URL.

This request retrieves a single instance group specified by identifier in the URL.

GET /instance_groups/{id}
(vpc *VpcV1) GetInstanceGroup(getInstanceGroupOptions *GetInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceGroupWithContext(ctx context.Context, getInstanceGroupOptions *GetInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error)
get_instance_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroup> getInstanceGroup(GetInstanceGroupOptions getInstanceGroupOptions)
getInstanceGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.instance-group.read

Update an instance group

This request updates an instance group with the information provided instance group patch. The instance group patch object is structured in the same way as a retrieved instance group and contains only the information to be updated.

This request updates an instance group with the information provided instance group patch. The instance group patch object is structured in the same way as a retrieved instance group and contains only the information to be updated.

This request updates an instance group with the information provided instance group patch. The instance group patch object is structured in the same way as a retrieved instance group and contains only the information to be updated.

This request updates an instance group with the information provided instance group patch. The instance group patch object is structured in the same way as a retrieved instance group and contains only the information to be updated.

This request updates an instance group with the information provided instance group patch. The instance group patch object is structured in the same way as a retrieved instance group and contains only the information to be updated.

PATCH /instance_groups/{id}
(vpc *VpcV1) UpdateInstanceGroup(updateInstanceGroupOptions *UpdateInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceGroupWithContext(ctx context.Context, updateInstanceGroupOptions *UpdateInstanceGroupOptions) (result *InstanceGroup, response *core.DetailedResponse, err error)
update_instance_group(
        self,
        id: str,
        instance_group_patch: 'InstanceGroupPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroup> updateInstanceGroup(UpdateInstanceGroupOptions updateInstanceGroupOptions)
updateInstanceGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

  • is.instance.instance-template.read

    Required when instance_template is specified

  • is.subnet.subnet.operate

    Required when subnets is specified

  • is.load-balancer.load-balancer.manage

    Required when load_balancer_pool is specified

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.instance-group.update

Delete an instance group load balancer

This request unbinds the instance group from the load balancer pool, and deletes the load balancer pool members.

This request unbinds the instance group from the load balancer pool, and deletes the load balancer pool members.

This request unbinds the instance group from the load balancer pool, and deletes the load balancer pool members.

This request unbinds the instance group from the load balancer pool, and deletes the load balancer pool members.

This request unbinds the instance group from the load balancer pool, and deletes the load balancer pool members.

DELETE /instance_groups/{instance_group_id}/load_balancer
(vpc *VpcV1) DeleteInstanceGroupLoadBalancer(deleteInstanceGroupLoadBalancerOptions *DeleteInstanceGroupLoadBalancerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceGroupLoadBalancerWithContext(ctx context.Context, deleteInstanceGroupLoadBalancerOptions *DeleteInstanceGroupLoadBalancerOptions) (response *core.DetailedResponse, err error)
delete_instance_group_load_balancer(
        self,
        instance_group_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceGroupLoadBalancer(DeleteInstanceGroupLoadBalancerOptions deleteInstanceGroupLoadBalancerOptions)
deleteInstanceGroupLoadBalancer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.load-balancer.delete

List all managers for an instance group

This request lists all managers for an instance group.

This request lists all managers for an instance group.

This request lists all managers for an instance group.

This request lists all managers for an instance group.

This request lists all managers for an instance group.

GET /instance_groups/{instance_group_id}/managers
(vpc *VpcV1) ListInstanceGroupManagers(listInstanceGroupManagersOptions *ListInstanceGroupManagersOptions) (result *InstanceGroupManagerCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceGroupManagersWithContext(ctx context.Context, listInstanceGroupManagersOptions *ListInstanceGroupManagersOptions) (result *InstanceGroupManagerCollection, response *core.DetailedResponse, err error)
list_instance_group_managers(
        self,
        instance_group_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerCollection> listInstanceGroupManagers(ListInstanceGroupManagersOptions listInstanceGroupManagersOptions)
listInstanceGroupManagers(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager.read

Create a manager for an instance group

This request creates a new instance group manager

This request creates a new instance group manager.

This request creates a new instance group manager.

This request creates a new instance group manager.

This request creates a new instance group manager.

POST /instance_groups/{instance_group_id}/managers
(vpc *VpcV1) CreateInstanceGroupManager(createInstanceGroupManagerOptions *CreateInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceGroupManagerWithContext(ctx context.Context, createInstanceGroupManagerOptions *CreateInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error)
create_instance_group_manager(
        self,
        instance_group_id: str,
        instance_group_manager_prototype: 'InstanceGroupManagerPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManager> createInstanceGroupManager(CreateInstanceGroupManagerOptions createInstanceGroupManagerOptions)
createInstanceGroupManager(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager.create

Delete an instance group manager

This request deletes an instance group manager. This operation cannot be reversed.

This request deletes an instance group manager. This operation cannot be reversed.

This request deletes an instance group manager. This operation cannot be reversed.

This request deletes an instance group manager. This operation cannot be reversed.

This request deletes an instance group manager. This operation cannot be reversed.

DELETE /instance_groups/{instance_group_id}/managers/{id}
(vpc *VpcV1) DeleteInstanceGroupManager(deleteInstanceGroupManagerOptions *DeleteInstanceGroupManagerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceGroupManagerWithContext(ctx context.Context, deleteInstanceGroupManagerOptions *DeleteInstanceGroupManagerOptions) (response *core.DetailedResponse, err error)
delete_instance_group_manager(
        self,
        instance_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceGroupManager(DeleteInstanceGroupManagerOptions deleteInstanceGroupManagerOptions)
deleteInstanceGroupManager(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager.delete

Retrieve an instance group manager

This request retrieves a single instance group manager specified by identifier in the URL.

This request retrieves a single instance group manager specified by identifier in the URL.

This request retrieves a single instance group manager specified by identifier in the URL.

This request retrieves a single instance group manager specified by identifier in the URL.

This request retrieves a single instance group manager specified by identifier in the URL.

GET /instance_groups/{instance_group_id}/managers/{id}
(vpc *VpcV1) GetInstanceGroupManager(getInstanceGroupManagerOptions *GetInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceGroupManagerWithContext(ctx context.Context, getInstanceGroupManagerOptions *GetInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error)
get_instance_group_manager(
        self,
        instance_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManager> getInstanceGroupManager(GetInstanceGroupManagerOptions getInstanceGroupManagerOptions)
getInstanceGroupManager(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager.read

Update an instance group manager

This request updates an instance group manager with the information provided instance group manager patch.

This request updates an instance group manager with the information provided instance group manager patch.

This request updates an instance group manager with the information provided instance group manager patch.

This request updates an instance group manager with the information provided instance group manager patch.

This request updates an instance group manager with the information provided instance group manager patch.

PATCH /instance_groups/{instance_group_id}/managers/{id}
(vpc *VpcV1) UpdateInstanceGroupManager(updateInstanceGroupManagerOptions *UpdateInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceGroupManagerWithContext(ctx context.Context, updateInstanceGroupManagerOptions *UpdateInstanceGroupManagerOptions) (result InstanceGroupManagerIntf, response *core.DetailedResponse, err error)
update_instance_group_manager(
        self,
        instance_group_id: str,
        id: str,
        instance_group_manager_patch: 'InstanceGroupManagerPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManager> updateInstanceGroupManager(UpdateInstanceGroupManagerOptions updateInstanceGroupManagerOptions)
updateInstanceGroupManager(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager.update

List all actions for an instance group manager

This request lists all instance group actions for an instance group manager.

This request lists all instance group actions for an instance group manager.

This request lists all instance group actions for an instance group manager.

This request lists all instance group actions for an instance group manager.

This request lists all instance group actions for an instance group manager.

GET /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions
(vpc *VpcV1) ListInstanceGroupManagerActions(listInstanceGroupManagerActionsOptions *ListInstanceGroupManagerActionsOptions) (result *InstanceGroupManagerActionsCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceGroupManagerActionsWithContext(ctx context.Context, listInstanceGroupManagerActionsOptions *ListInstanceGroupManagerActionsOptions) (result *InstanceGroupManagerActionsCollection, response *core.DetailedResponse, err error)
list_instance_group_manager_actions(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerActionsCollection> listInstanceGroupManagerActions(ListInstanceGroupManagerActionsOptions listInstanceGroupManagerActionsOptions)
listInstanceGroupManagerActions(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.list

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_action.read

Create an instance group manager action

This request creates a new instance group manager action

This request creates a new instance group manager action.

This request creates a new instance group manager action.

This request creates a new instance group manager action.

This request creates a new instance group manager action.

POST /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions
(vpc *VpcV1) CreateInstanceGroupManagerAction(createInstanceGroupManagerActionOptions *CreateInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceGroupManagerActionWithContext(ctx context.Context, createInstanceGroupManagerActionOptions *CreateInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error)
create_instance_group_manager_action(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        instance_group_manager_action_prototype: 'InstanceGroupManagerActionPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerAction> createInstanceGroupManagerAction(CreateInstanceGroupManagerActionOptions createInstanceGroupManagerActionOptions)
createInstanceGroupManagerAction(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_action.update

Delete specified instance group manager action

This request deletes an instance group manager action. This operation cannot be reversed.

This request deletes an instance group manager action. This operation cannot be reversed.

This request deletes an instance group manager action. This operation cannot be reversed.

This request deletes an instance group manager action. This operation cannot be reversed.

This request deletes an instance group manager action. This operation cannot be reversed.

DELETE /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions/{id}
(vpc *VpcV1) DeleteInstanceGroupManagerAction(deleteInstanceGroupManagerActionOptions *DeleteInstanceGroupManagerActionOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceGroupManagerActionWithContext(ctx context.Context, deleteInstanceGroupManagerActionOptions *DeleteInstanceGroupManagerActionOptions) (response *core.DetailedResponse, err error)
delete_instance_group_manager_action(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceGroupManagerAction(DeleteInstanceGroupManagerActionOptions deleteInstanceGroupManagerActionOptions)
deleteInstanceGroupManagerAction(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_action.update

Retrieve specified instance group manager action

This request retrieves a single instance group manager action specified by identifier in the URL.

This request retrieves a single instance group manager action specified by identifier in the URL.

This request retrieves a single instance group manager action specified by identifier in the URL.

This request retrieves a single instance group manager action specified by identifier in the URL.

This request retrieves a single instance group manager action specified by identifier in the URL.

GET /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions/{id}
(vpc *VpcV1) GetInstanceGroupManagerAction(getInstanceGroupManagerActionOptions *GetInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceGroupManagerActionWithContext(ctx context.Context, getInstanceGroupManagerActionOptions *GetInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error)
get_instance_group_manager_action(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerAction> getInstanceGroupManagerAction(GetInstanceGroupManagerActionOptions getInstanceGroupManagerActionOptions)
getInstanceGroupManagerAction(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.instance-group.read

Update specified instance group manager action

This request updates an instance group manager action.

This request updates an instance group manager action.

This request updates an instance group manager action.

This request updates an instance group manager action.

This request updates an instance group manager action.

PATCH /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/actions/{id}
(vpc *VpcV1) UpdateInstanceGroupManagerAction(updateInstanceGroupManagerActionOptions *UpdateInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceGroupManagerActionWithContext(ctx context.Context, updateInstanceGroupManagerActionOptions *UpdateInstanceGroupManagerActionOptions) (result InstanceGroupManagerActionIntf, response *core.DetailedResponse, err error)
update_instance_group_manager_action(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        id: str,
        instance_group_manager_action_patch: 'InstanceGroupManagerActionPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerAction> updateInstanceGroupManagerAction(UpdateInstanceGroupManagerActionOptions updateInstanceGroupManagerActionOptions)
updateInstanceGroupManagerAction(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_action.update

List all policies for an instance group manager

This request lists all policies for an instance group manager.

This request lists all policies for an instance group manager.

This request lists all policies for an instance group manager.

This request lists all policies for an instance group manager.

This request lists all policies for an instance group manager.

GET /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies
(vpc *VpcV1) ListInstanceGroupManagerPolicies(listInstanceGroupManagerPoliciesOptions *ListInstanceGroupManagerPoliciesOptions) (result *InstanceGroupManagerPolicyCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceGroupManagerPoliciesWithContext(ctx context.Context, listInstanceGroupManagerPoliciesOptions *ListInstanceGroupManagerPoliciesOptions) (result *InstanceGroupManagerPolicyCollection, response *core.DetailedResponse, err error)
list_instance_group_manager_policies(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerPolicyCollection> listInstanceGroupManagerPolicies(ListInstanceGroupManagerPoliciesOptions listInstanceGroupManagerPoliciesOptions)
listInstanceGroupManagerPolicies(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_policy.read

Create a policy for an instance group manager

This request creates a new instance group manager policy

This request creates a new instance group manager policy.

This request creates a new instance group manager policy.

This request creates a new instance group manager policy.

This request creates a new instance group manager policy.

POST /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies
(vpc *VpcV1) CreateInstanceGroupManagerPolicy(createInstanceGroupManagerPolicyOptions *CreateInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateInstanceGroupManagerPolicyWithContext(ctx context.Context, createInstanceGroupManagerPolicyOptions *CreateInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error)
create_instance_group_manager_policy(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        instance_group_manager_policy_prototype: 'InstanceGroupManagerPolicyPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerPolicy> createInstanceGroupManagerPolicy(CreateInstanceGroupManagerPolicyOptions createInstanceGroupManagerPolicyOptions)
createInstanceGroupManagerPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_policy.create

Delete an instance group manager policy

This request deletes an instance group manager policy. This operation cannot be reversed.

This request deletes an instance group manager policy. This operation cannot be reversed.

This request deletes an instance group manager policy. This operation cannot be reversed.

This request deletes an instance group manager policy. This operation cannot be reversed.

This request deletes an instance group manager policy. This operation cannot be reversed.

DELETE /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies/{id}
(vpc *VpcV1) DeleteInstanceGroupManagerPolicy(deleteInstanceGroupManagerPolicyOptions *DeleteInstanceGroupManagerPolicyOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceGroupManagerPolicyWithContext(ctx context.Context, deleteInstanceGroupManagerPolicyOptions *DeleteInstanceGroupManagerPolicyOptions) (response *core.DetailedResponse, err error)
delete_instance_group_manager_policy(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceGroupManagerPolicy(DeleteInstanceGroupManagerPolicyOptions deleteInstanceGroupManagerPolicyOptions)
deleteInstanceGroupManagerPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_policy.delete

Retrieve an instance group manager policy

This request retrieves a single instance group manager policy specified by identifier in the URL.

This request retrieves a single instance group manager policy specified by identifier in the URL.

This request retrieves a single instance group manager policy specified by identifier in the URL.

This request retrieves a single instance group manager policy specified by identifier in the URL.

This request retrieves a single instance group manager policy specified by identifier in the URL.

GET /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies/{id}
(vpc *VpcV1) GetInstanceGroupManagerPolicy(getInstanceGroupManagerPolicyOptions *GetInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceGroupManagerPolicyWithContext(ctx context.Context, getInstanceGroupManagerPolicyOptions *GetInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error)
get_instance_group_manager_policy(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerPolicy> getInstanceGroupManagerPolicy(GetInstanceGroupManagerPolicyOptions getInstanceGroupManagerPolicyOptions)
getInstanceGroupManagerPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_policy.read

Update an instance group manager policy

This request updates an instance group manager policy.

This request updates an instance group manager policy.

This request updates an instance group manager policy.

This request updates an instance group manager policy.

This request updates an instance group manager policy.

PATCH /instance_groups/{instance_group_id}/managers/{instance_group_manager_id}/policies/{id}
(vpc *VpcV1) UpdateInstanceGroupManagerPolicy(updateInstanceGroupManagerPolicyOptions *UpdateInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceGroupManagerPolicyWithContext(ctx context.Context, updateInstanceGroupManagerPolicyOptions *UpdateInstanceGroupManagerPolicyOptions) (result InstanceGroupManagerPolicyIntf, response *core.DetailedResponse, err error)
update_instance_group_manager_policy(
        self,
        instance_group_id: str,
        instance_group_manager_id: str,
        id: str,
        instance_group_manager_policy_patch: 'InstanceGroupManagerPolicyPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupManagerPolicy> updateInstanceGroupManagerPolicy(UpdateInstanceGroupManagerPolicyOptions updateInstanceGroupManagerPolicyOptions)
updateInstanceGroupManagerPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.manager_policy.update

Delete all memberships from an instance group

This request deletes all memberships of an instance group. This operation cannot be reversed. reversed. Any memberships that have delete_instance_on_membership_delete set to true will also have their instances deleted.

This request deletes all memberships of an instance group. This operation cannot be reversed. reversed. Any memberships that have delete_instance_on_membership_delete set to true will also have their instances deleted.

This request deletes all memberships of an instance group. This operation cannot be reversed. reversed. Any memberships that have delete_instance_on_membership_delete set to true will also have their instances deleted.

This request deletes all memberships of an instance group. This operation cannot be reversed. reversed. Any memberships that have delete_instance_on_membership_delete set to true will also have their instances deleted.

This request deletes all memberships of an instance group. This operation cannot be reversed. reversed. Any memberships that have delete_instance_on_membership_delete set to true will also have their instances deleted.

DELETE /instance_groups/{instance_group_id}/memberships
(vpc *VpcV1) DeleteInstanceGroupMemberships(deleteInstanceGroupMembershipsOptions *DeleteInstanceGroupMembershipsOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceGroupMembershipsWithContext(ctx context.Context, deleteInstanceGroupMembershipsOptions *DeleteInstanceGroupMembershipsOptions) (response *core.DetailedResponse, err error)
delete_instance_group_memberships(
        self,
        instance_group_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceGroupMemberships(DeleteInstanceGroupMembershipsOptions deleteInstanceGroupMembershipsOptions)
deleteInstanceGroupMemberships(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.membership.delete

List all memberships for an instance group

This request lists all instance group memberships for an instance group.

This request lists all instance group memberships for an instance group.

This request lists all instance group memberships for an instance group.

This request lists all instance group memberships for an instance group.

This request lists all instance group memberships for an instance group.

GET /instance_groups/{instance_group_id}/memberships
(vpc *VpcV1) ListInstanceGroupMemberships(listInstanceGroupMembershipsOptions *ListInstanceGroupMembershipsOptions) (result *InstanceGroupMembershipCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListInstanceGroupMembershipsWithContext(ctx context.Context, listInstanceGroupMembershipsOptions *ListInstanceGroupMembershipsOptions) (result *InstanceGroupMembershipCollection, response *core.DetailedResponse, err error)
list_instance_group_memberships(
        self,
        instance_group_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupMembershipCollection> listInstanceGroupMemberships(ListInstanceGroupMembershipsOptions listInstanceGroupMembershipsOptions)
listInstanceGroupMemberships(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.membership.read

Delete an instance group membership

This request deletes a memberships of an instance group. This operation cannot be reversed. reversed. If the membership has delete_instance_on_membership_delete set to true, the instance will also be deleted.

This request deletes a memberships of an instance group. This operation cannot be reversed. reversed. If the membership has delete_instance_on_membership_delete set to true, the instance will also be deleted.

This request deletes a memberships of an instance group. This operation cannot be reversed. reversed. If the membership has delete_instance_on_membership_delete set to true, the instance will also be deleted.

This request deletes a memberships of an instance group. This operation cannot be reversed. reversed. If the membership has delete_instance_on_membership_delete set to true, the instance will also be deleted.

This request deletes a memberships of an instance group. This operation cannot be reversed. reversed. If the membership has delete_instance_on_membership_delete set to true, the instance will also be deleted.

DELETE /instance_groups/{instance_group_id}/memberships/{id}
(vpc *VpcV1) DeleteInstanceGroupMembership(deleteInstanceGroupMembershipOptions *DeleteInstanceGroupMembershipOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteInstanceGroupMembershipWithContext(ctx context.Context, deleteInstanceGroupMembershipOptions *DeleteInstanceGroupMembershipOptions) (response *core.DetailedResponse, err error)
delete_instance_group_membership(
        self,
        instance_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteInstanceGroupMembership(DeleteInstanceGroupMembershipOptions deleteInstanceGroupMembershipOptions)
deleteInstanceGroupMembership(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

    Required when delete_membership_on_instance_delete is true

  • is.instance.instance.delete

  • is.load-balancer.load-balancer.manage

    Required when the instance group manages a load balancer

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.membership.delete

Retrieve an instance group membership

This request retrieves a single instance group membership specified by identifier in the URL.

This request retrieves a single instance group membership specified by identifier in the URL.

This request retrieves a single instance group membership specified by identifier in the URL.

This request retrieves a single instance group membership specified by identifier in the URL.

This request retrieves a single instance group membership specified by identifier in the URL.

GET /instance_groups/{instance_group_id}/memberships/{id}
(vpc *VpcV1) GetInstanceGroupMembership(getInstanceGroupMembershipOptions *GetInstanceGroupMembershipOptions) (result *InstanceGroupMembership, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetInstanceGroupMembershipWithContext(ctx context.Context, getInstanceGroupMembershipOptions *GetInstanceGroupMembershipOptions) (result *InstanceGroupMembership, response *core.DetailedResponse, err error)
get_instance_group_membership(
        self,
        instance_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupMembership> getInstanceGroupMembership(GetInstanceGroupMembershipOptions getInstanceGroupMembershipOptions)
getInstanceGroupMembership(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.read

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.membership.read

Update an instance group membership

This request updates an instance group membership with the information provided instance group membership patch.

This request updates an instance group membership with the information provided instance group membership patch.

This request updates an instance group membership with the information provided instance group membership patch.

This request updates an instance group membership with the information provided instance group membership patch.

This request updates an instance group membership with the information provided instance group membership patch.

PATCH /instance_groups/{instance_group_id}/memberships/{id}
(vpc *VpcV1) UpdateInstanceGroupMembership(updateInstanceGroupMembershipOptions *UpdateInstanceGroupMembershipOptions) (result *InstanceGroupMembership, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateInstanceGroupMembershipWithContext(ctx context.Context, updateInstanceGroupMembershipOptions *UpdateInstanceGroupMembershipOptions) (result *InstanceGroupMembership, response *core.DetailedResponse, err error)
update_instance_group_membership(
        self,
        instance_group_id: str,
        id: str,
        instance_group_membership_patch: 'InstanceGroupMembershipPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<InstanceGroupMembership> updateInstanceGroupMembership(UpdateInstanceGroupMembershipOptions updateInstanceGroupMembershipOptions)
updateInstanceGroupMembership(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.instance-group.instance-group.update

Auditing

Calling this method generates the following auditing event.

  • is.instance-group.membership.update

List all reservations

This request lists all reservations in the region. A reservation provides reserved capacity for a specified profile in a specified zone. A reservation can also include a long-term committed use discount.

The reservations will be sorted by their created_at property values, with newest reservations first. Reservations with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all reservations in the region. A reservation provides reserved capacity for a specified profile in a specified zone. A reservation can also include a long-term committed use discount.

The reservations will be sorted by their created_at property values, with newest reservations first. Reservations with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all reservations in the region. A reservation provides reserved capacity for a specified profile in a specified zone. A reservation can also include a long-term committed use discount.

The reservations will be sorted by their created_at property values, with newest reservations first. Reservations with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all reservations in the region. A reservation provides reserved capacity for a specified profile in a specified zone. A reservation can also include a long-term committed use discount.

The reservations will be sorted by their created_at property values, with newest reservations first. Reservations with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all reservations in the region. A reservation provides reserved capacity for a specified profile in a specified zone. A reservation can also include a long-term committed use discount.

The reservations will be sorted by their created_at property values, with newest reservations first. Reservations with identical created_at property values will in turn be sorted by ascending name property values.

GET /reservations
(vpc *VpcV1) ListReservations(listReservationsOptions *ListReservationsOptions) (result *ReservationCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListReservationsWithContext(ctx context.Context, listReservationsOptions *ListReservationsOptions) (result *ReservationCollection, response *core.DetailedResponse, err error)
list_reservations(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        name: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        zone_name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservationCollection> listReservations(ListReservationsOptions listReservationsOptions)
listReservations(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.reservation.reservation.list

  • is.reservation.reservation.read

Auditing

Calling this method generates the following auditing event.

  • is.reservation.reservation.read

Create a reservation

This request creates a new reservation from a reservation prototype object. The prototype object is structured in the same way as a retrieved reservation, and contains the information necessary to create the new reservation.

This request creates a new reservation from a reservation prototype object. The prototype object is structured in the same way as a retrieved reservation, and contains the information necessary to create the new reservation.

This request creates a new reservation from a reservation prototype object. The prototype object is structured in the same way as a retrieved reservation, and contains the information necessary to create the new reservation.

This request creates a new reservation from a reservation prototype object. The prototype object is structured in the same way as a retrieved reservation, and contains the information necessary to create the new reservation.

This request creates a new reservation from a reservation prototype object. The prototype object is structured in the same way as a retrieved reservation, and contains the information necessary to create the new reservation.

POST /reservations
(vpc *VpcV1) CreateReservation(createReservationOptions *CreateReservationOptions) (result *Reservation, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateReservationWithContext(ctx context.Context, createReservationOptions *CreateReservationOptions) (result *Reservation, response *core.DetailedResponse, err error)
create_reservation(
        self,
        capacity: 'ReservationCapacityPrototype',
        committed_use: 'ReservationCommittedUsePrototype',
        profile: 'ReservationProfilePrototype',
        zone: 'ZoneIdentity',
        *,
        affinity_policy: Optional[str] = None,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Reservation> createReservation(CreateReservationOptions createReservationOptions)
createReservation(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.reservation.reservation.create

Auditing

Calling this method generates the following auditing event.

  • is.reservation.reservation.create

Delete a reservation

This request deletes a reservation. This operation cannot be reversed. Reservations with a status of active are not allowed to be deleted.

This request deletes a reservation. This operation cannot be reversed. Reservations with a status of active are not allowed to be deleted.

This request deletes a reservation. This operation cannot be reversed. Reservations with a status of active are not allowed to be deleted.

This request deletes a reservation. This operation cannot be reversed. Reservations with a status of active are not allowed to be deleted.

This request deletes a reservation. This operation cannot be reversed. Reservations with a status of active are not allowed to be deleted.

DELETE /reservations/{id}
(vpc *VpcV1) DeleteReservation(deleteReservationOptions *DeleteReservationOptions) (result *Reservation, response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteReservationWithContext(ctx context.Context, deleteReservationOptions *DeleteReservationOptions) (result *Reservation, response *core.DetailedResponse, err error)
delete_reservation(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Reservation> deleteReservation(DeleteReservationOptions deleteReservationOptions)
deleteReservation(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.reservation.reservation.delete

Auditing

Calling this method generates the following auditing event.

  • is.reservation.reservation.delete

Retrieve a reservation

This request retrieves a single reservation specified by identifier in the URL.

This request retrieves a single reservation specified by identifier in the URL.

This request retrieves a single reservation specified by identifier in the URL.

This request retrieves a single reservation specified by identifier in the URL.

This request retrieves a single reservation specified by identifier in the URL.

GET /reservations/{id}
(vpc *VpcV1) GetReservation(getReservationOptions *GetReservationOptions) (result *Reservation, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetReservationWithContext(ctx context.Context, getReservationOptions *GetReservationOptions) (result *Reservation, response *core.DetailedResponse, err error)
get_reservation(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Reservation> getReservation(GetReservationOptions getReservationOptions)
getReservation(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.reservation.reservation.read

Auditing

Calling this method generates the following auditing event.

  • is.reservation.reservation.read

Update a reservation

This request updates a reservation with the information provided in a reservation patch object. The patch object is structured in the same way as a retrieved reservation and needs to contain only the information to be updated.

This request updates a reservation with the information provided in a reservation patch object. The patch object is structured in the same way as a retrieved reservation and needs to contain only the information to be updated.

This request updates a reservation with the information provided in a reservation patch object. The patch object is structured in the same way as a retrieved reservation and needs to contain only the information to be updated.

This request updates a reservation with the information provided in a reservation patch object. The patch object is structured in the same way as a retrieved reservation and needs to contain only the information to be updated.

This request updates a reservation with the information provided in a reservation patch object. The patch object is structured in the same way as a retrieved reservation and needs to contain only the information to be updated.

PATCH /reservations/{id}
(vpc *VpcV1) UpdateReservation(updateReservationOptions *UpdateReservationOptions) (result *Reservation, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateReservationWithContext(ctx context.Context, updateReservationOptions *UpdateReservationOptions) (result *Reservation, response *core.DetailedResponse, err error)
update_reservation(
        self,
        id: str,
        reservation_patch: 'ReservationPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Reservation> updateReservation(UpdateReservationOptions updateReservationOptions)
updateReservation(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.reservation.reservation.update

Auditing

Calling this method generates the following auditing event.

  • is.reservation.reservation.update

Activate a reservation

This request activates a reservation. For this request to succeed, the reservation status must be inactive.

This request activates a reservation. For this request to succeed, the reservation status must be inactive.

This request activates a reservation. For this request to succeed, the reservation status must be inactive.

This request activates a reservation. For this request to succeed, the reservation status must be inactive.

This request activates a reservation. For this request to succeed, the reservation status must be inactive.

POST /reservations/{id}/activate
(vpc *VpcV1) ActivateReservation(activateReservationOptions *ActivateReservationOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) ActivateReservationWithContext(ctx context.Context, activateReservationOptions *ActivateReservationOptions) (response *core.DetailedResponse, err error)
activate_reservation(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> activateReservation(ActivateReservationOptions activateReservationOptions)
activateReservation(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.reservation.reservation.activate

Auditing

Calling this method generates the following auditing event.

  • is.reservation.reservation.activate

List all dedicated host groups

This request lists all dedicated host groups in the region. Host groups are a collection of dedicated hosts for placement of instances. Each dedicated host must belong to one and only one group. Host groups do not span zones.

This request lists all dedicated host groups in the region. Host groups are a collection of dedicated hosts for placement of instances. Each dedicated host must belong to one and only one group. Host groups do not span zones.

This request lists all dedicated host groups in the region. Host groups are a collection of dedicated hosts for placement of instances. Each dedicated host must belong to one and only one group. Host groups do not span zones.

This request lists all dedicated host groups in the region. Host groups are a collection of dedicated hosts for placement of instances. Each dedicated host must belong to one and only one group. Host groups do not span zones.

This request lists all dedicated host groups in the region. Host groups are a collection of dedicated hosts for placement of instances. Each dedicated host must belong to one and only one group. Host groups do not span zones.

GET /dedicated_host/groups
(vpc *VpcV1) ListDedicatedHostGroups(listDedicatedHostGroupsOptions *ListDedicatedHostGroupsOptions) (result *DedicatedHostGroupCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListDedicatedHostGroupsWithContext(ctx context.Context, listDedicatedHostGroupsOptions *ListDedicatedHostGroupsOptions) (result *DedicatedHostGroupCollection, response *core.DetailedResponse, err error)
list_dedicated_host_groups(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        zone_name: Optional[str] = None,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostGroupCollection> listDedicatedHostGroups(ListDedicatedHostGroupsOptions listDedicatedHostGroupsOptions)
listDedicatedHostGroups(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host-group.read

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host-group.read

Create a dedicated host group

This request creates a new dedicated host group.

This request creates a new dedicated host group.

This request creates a new dedicated host group.

This request creates a new dedicated host group.

This request creates a new dedicated host group.

POST /dedicated_host/groups
(vpc *VpcV1) CreateDedicatedHostGroup(createDedicatedHostGroupOptions *CreateDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateDedicatedHostGroupWithContext(ctx context.Context, createDedicatedHostGroupOptions *CreateDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error)
create_dedicated_host_group(
        self,
        class_: str,
        family: str,
        zone: 'ZoneIdentity',
        *,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostGroup> createDedicatedHostGroup(CreateDedicatedHostGroupOptions createDedicatedHostGroupOptions)
createDedicatedHostGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host-group.create

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host-group.create

Delete a dedicated host group

This request deletes a dedicated host group.

This request deletes a dedicated host group.

This request deletes a dedicated host group.

This request deletes a dedicated host group.

This request deletes a dedicated host group.

DELETE /dedicated_host/groups/{id}
(vpc *VpcV1) DeleteDedicatedHostGroup(deleteDedicatedHostGroupOptions *DeleteDedicatedHostGroupOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteDedicatedHostGroupWithContext(ctx context.Context, deleteDedicatedHostGroupOptions *DeleteDedicatedHostGroupOptions) (response *core.DetailedResponse, err error)
delete_dedicated_host_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteDedicatedHostGroup(DeleteDedicatedHostGroupOptions deleteDedicatedHostGroupOptions)
deleteDedicatedHostGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host-group.delete

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host-group.delete

Retrieve a dedicated host group

This request retrieves a single dedicated host group specified by the identifier in the URL.

This request retrieves a single dedicated host group specified by the identifier in the URL.

This request retrieves a single dedicated host group specified by the identifier in the URL.

This request retrieves a single dedicated host group specified by the identifier in the URL.

This request retrieves a single dedicated host group specified by the identifier in the URL.

GET /dedicated_host/groups/{id}
(vpc *VpcV1) GetDedicatedHostGroup(getDedicatedHostGroupOptions *GetDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetDedicatedHostGroupWithContext(ctx context.Context, getDedicatedHostGroupOptions *GetDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error)
get_dedicated_host_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostGroup> getDedicatedHostGroup(GetDedicatedHostGroupOptions getDedicatedHostGroupOptions)
getDedicatedHostGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host-group.read

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host-group.read

Update a dedicated host group

This request updates a dedicated host group with the information in a provided dedicated host group patch. The dedicated host group patch object is structured in the same way as a retrieved dedicated host group and contains only the information to be updated.

This request updates a dedicated host group with the information in a provided dedicated host group patch. The dedicated host group patch object is structured in the same way as a retrieved dedicated host group and contains only the information to be updated.

This request updates a dedicated host group with the information in a provided dedicated host group patch. The dedicated host group patch object is structured in the same way as a retrieved dedicated host group and contains only the information to be updated.

This request updates a dedicated host group with the information in a provided dedicated host group patch. The dedicated host group patch object is structured in the same way as a retrieved dedicated host group and contains only the information to be updated.

This request updates a dedicated host group with the information in a provided dedicated host group patch. The dedicated host group patch object is structured in the same way as a retrieved dedicated host group and contains only the information to be updated.

PATCH /dedicated_host/groups/{id}
(vpc *VpcV1) UpdateDedicatedHostGroup(updateDedicatedHostGroupOptions *UpdateDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateDedicatedHostGroupWithContext(ctx context.Context, updateDedicatedHostGroupOptions *UpdateDedicatedHostGroupOptions) (result *DedicatedHostGroup, response *core.DetailedResponse, err error)
update_dedicated_host_group(
        self,
        id: str,
        dedicated_host_group_patch: 'DedicatedHostGroupPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostGroup> updateDedicatedHostGroup(UpdateDedicatedHostGroupOptions updateDedicatedHostGroupOptions)
updateDedicatedHostGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host-group.update

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host-group.update

List all dedicated host profiles

This request lists provisionable dedicated host profiles in the region. A dedicated host profile specifies the hardware characteristics for a dedicated host.

This request lists provisionable dedicated host profiles in the region. A dedicated host profile specifies the hardware characteristics for a dedicated host.

This request lists provisionable dedicated host profiles in the region. A dedicated host profile specifies the hardware characteristics for a dedicated host.

This request lists provisionable dedicated host profiles in the region. A dedicated host profile specifies the hardware characteristics for a dedicated host.

This request lists provisionable dedicated host profiles in the region. A dedicated host profile specifies the hardware characteristics for a dedicated host.

GET /dedicated_host/profiles
(vpc *VpcV1) ListDedicatedHostProfiles(listDedicatedHostProfilesOptions *ListDedicatedHostProfilesOptions) (result *DedicatedHostProfileCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListDedicatedHostProfilesWithContext(ctx context.Context, listDedicatedHostProfilesOptions *ListDedicatedHostProfilesOptions) (result *DedicatedHostProfileCollection, response *core.DetailedResponse, err error)
list_dedicated_host_profiles(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostProfileCollection> listDedicatedHostProfiles(ListDedicatedHostProfilesOptions listDedicatedHostProfilesOptions)
listDedicatedHostProfiles(params)

Retrieve a dedicated host profile

This request retrieves a single dedicated host profile specified by the name in the URL.

This request retrieves a single dedicated host profile specified by the name in the URL.

This request retrieves a single dedicated host profile specified by the name in the URL.

This request retrieves a single dedicated host profile specified by the name in the URL.

This request retrieves a single dedicated host profile specified by the name in the URL.

GET /dedicated_host/profiles/{name}
(vpc *VpcV1) GetDedicatedHostProfile(getDedicatedHostProfileOptions *GetDedicatedHostProfileOptions) (result *DedicatedHostProfile, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetDedicatedHostProfileWithContext(ctx context.Context, getDedicatedHostProfileOptions *GetDedicatedHostProfileOptions) (result *DedicatedHostProfile, response *core.DetailedResponse, err error)
get_dedicated_host_profile(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostProfile> getDedicatedHostProfile(GetDedicatedHostProfileOptions getDedicatedHostProfileOptions)
getDedicatedHostProfile(params)

List all dedicated hosts

This request lists all dedicated hosts in the region.

This request lists all dedicated hosts in the region.

This request lists all dedicated hosts in the region.

This request lists all dedicated hosts in the region.

This request lists all dedicated hosts in the region.

GET /dedicated_hosts
(vpc *VpcV1) ListDedicatedHosts(listDedicatedHostsOptions *ListDedicatedHostsOptions) (result *DedicatedHostCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListDedicatedHostsWithContext(ctx context.Context, listDedicatedHostsOptions *ListDedicatedHostsOptions) (result *DedicatedHostCollection, response *core.DetailedResponse, err error)
list_dedicated_hosts(
        self,
        *,
        dedicated_host_group_id: Optional[str] = None,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        zone_name: Optional[str] = None,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostCollection> listDedicatedHosts(ListDedicatedHostsOptions listDedicatedHostsOptions)
listDedicatedHosts(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host.read

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host.read

Create a dedicated host

This request creates a new dedicated host.

This request creates a new dedicated host.

This request creates a new dedicated host.

This request creates a new dedicated host.

This request creates a new dedicated host.

POST /dedicated_hosts
(vpc *VpcV1) CreateDedicatedHost(createDedicatedHostOptions *CreateDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateDedicatedHostWithContext(ctx context.Context, createDedicatedHostOptions *CreateDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error)
create_dedicated_host(
        self,
        dedicated_host_prototype: 'DedicatedHostPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHost> createDedicatedHost(CreateDedicatedHostOptions createDedicatedHostOptions)
createDedicatedHost(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host.create

  • is.dedicated-host.dedicated-host-group.create

  • is.dedicated-host.dedicated-host-group.update

Auditing

Calling this method generates the following auditing events.

  • is.dedicated-host.dedicated-host.create

  • is.dedicated-host.dedicated-host-group.create

  • is.dedicated-host.dedicated-host-group.update

List all disks on a dedicated host

This request lists all disks on a dedicated host. A disk is a physical device that is locally attached to the compute node. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on a dedicated host. A disk is a physical device that is locally attached to the compute node. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on a dedicated host. A disk is a physical device that is locally attached to the compute node. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on a dedicated host. A disk is a physical device that is locally attached to the compute node. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on a dedicated host. A disk is a physical device that is locally attached to the compute node. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

GET /dedicated_hosts/{dedicated_host_id}/disks
(vpc *VpcV1) ListDedicatedHostDisks(listDedicatedHostDisksOptions *ListDedicatedHostDisksOptions) (result *DedicatedHostDiskCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListDedicatedHostDisksWithContext(ctx context.Context, listDedicatedHostDisksOptions *ListDedicatedHostDisksOptions) (result *DedicatedHostDiskCollection, response *core.DetailedResponse, err error)
list_dedicated_host_disks(
        self,
        dedicated_host_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostDiskCollection> listDedicatedHostDisks(ListDedicatedHostDisksOptions listDedicatedHostDisksOptions)
listDedicatedHostDisks(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host.read

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host.read

Retrieve a dedicated host disk

This request retrieves a single dedicated host disk specified by the identifier in the URL.

This request retrieves a single dedicated host disk specified by the identifier in the URL.

This request retrieves a single dedicated host disk specified by the identifier in the URL.

This request retrieves a single dedicated host disk specified by the identifier in the URL.

This request retrieves a single dedicated host disk specified by the identifier in the URL.

GET /dedicated_hosts/{dedicated_host_id}/disks/{id}
(vpc *VpcV1) GetDedicatedHostDisk(getDedicatedHostDiskOptions *GetDedicatedHostDiskOptions) (result *DedicatedHostDisk, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetDedicatedHostDiskWithContext(ctx context.Context, getDedicatedHostDiskOptions *GetDedicatedHostDiskOptions) (result *DedicatedHostDisk, response *core.DetailedResponse, err error)
get_dedicated_host_disk(
        self,
        dedicated_host_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostDisk> getDedicatedHostDisk(GetDedicatedHostDiskOptions getDedicatedHostDiskOptions)
getDedicatedHostDisk(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host.read

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host.read

Update a dedicated host disk

This request updates the dedicated host disk with the information in a provided patch.

This request updates the dedicated host disk with the information in a provided patch.

This request updates the dedicated host disk with the information in a provided patch.

This request updates the dedicated host disk with the information in a provided patch.

This request updates the dedicated host disk with the information in a provided patch.

PATCH /dedicated_hosts/{dedicated_host_id}/disks/{id}
(vpc *VpcV1) UpdateDedicatedHostDisk(updateDedicatedHostDiskOptions *UpdateDedicatedHostDiskOptions) (result *DedicatedHostDisk, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateDedicatedHostDiskWithContext(ctx context.Context, updateDedicatedHostDiskOptions *UpdateDedicatedHostDiskOptions) (result *DedicatedHostDisk, response *core.DetailedResponse, err error)
update_dedicated_host_disk(
        self,
        dedicated_host_id: str,
        id: str,
        dedicated_host_disk_patch: 'DedicatedHostDiskPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHostDisk> updateDedicatedHostDisk(UpdateDedicatedHostDiskOptions updateDedicatedHostDiskOptions)
updateDedicatedHostDisk(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host.update

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host.update

Delete a dedicated host

This request deletes a dedicated host.

This request deletes a dedicated host.

This request deletes a dedicated host.

This request deletes a dedicated host.

This request deletes a dedicated host.

DELETE /dedicated_hosts/{id}
(vpc *VpcV1) DeleteDedicatedHost(deleteDedicatedHostOptions *DeleteDedicatedHostOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteDedicatedHostWithContext(ctx context.Context, deleteDedicatedHostOptions *DeleteDedicatedHostOptions) (response *core.DetailedResponse, err error)
delete_dedicated_host(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteDedicatedHost(DeleteDedicatedHostOptions deleteDedicatedHostOptions)
deleteDedicatedHost(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host.delete

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host.delete

Retrieve a dedicated host

This request retrieves a single dedicated host specified by the identifiers in the URL.

This request retrieves a single dedicated host specified by the identifiers in the URL.

This request retrieves a single dedicated host specified by the identifiers in the URL.

This request retrieves a single dedicated host specified by the identifiers in the URL.

This request retrieves a single dedicated host specified by the identifiers in the URL.

GET /dedicated_hosts/{id}
(vpc *VpcV1) GetDedicatedHost(getDedicatedHostOptions *GetDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetDedicatedHostWithContext(ctx context.Context, getDedicatedHostOptions *GetDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error)
get_dedicated_host(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHost> getDedicatedHost(GetDedicatedHostOptions getDedicatedHostOptions)
getDedicatedHost(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host.read

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host.read

Update a dedicated host

This request updates a dedicated host with the information in a provided dedicated host patch. The dedicated host patch object is structured in the same way as a retrieved dedicated host and contains only the information to be updated.

This request updates a dedicated host with the information in a provided dedicated host patch. The dedicated host patch object is structured in the same way as a retrieved dedicated host and contains only the information to be updated.

This request updates a dedicated host with the information in a provided dedicated host patch. The dedicated host patch object is structured in the same way as a retrieved dedicated host and contains only the information to be updated.

This request updates a dedicated host with the information in a provided dedicated host patch. The dedicated host patch object is structured in the same way as a retrieved dedicated host and contains only the information to be updated.

This request updates a dedicated host with the information in a provided dedicated host patch. The dedicated host patch object is structured in the same way as a retrieved dedicated host and contains only the information to be updated.

PATCH /dedicated_hosts/{id}
(vpc *VpcV1) UpdateDedicatedHost(updateDedicatedHostOptions *UpdateDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateDedicatedHostWithContext(ctx context.Context, updateDedicatedHostOptions *UpdateDedicatedHostOptions) (result *DedicatedHost, response *core.DetailedResponse, err error)
update_dedicated_host(
        self,
        id: str,
        dedicated_host_patch: 'DedicatedHostPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<DedicatedHost> updateDedicatedHost(UpdateDedicatedHostOptions updateDedicatedHostOptions)
updateDedicatedHost(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.dedicated-host.dedicated-host.update

Auditing

Calling this method generates the following auditing event.

  • is.dedicated-host.dedicated-host.update

List all placement groups

This request lists all placement groups in the region.

This request lists all placement groups in the region.

This request lists all placement groups in the region.

This request lists all placement groups in the region.

This request lists all placement groups in the region.

GET /placement_groups
(vpc *VpcV1) ListPlacementGroups(listPlacementGroupsOptions *ListPlacementGroupsOptions) (result *PlacementGroupCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListPlacementGroupsWithContext(ctx context.Context, listPlacementGroupsOptions *ListPlacementGroupsOptions) (result *PlacementGroupCollection, response *core.DetailedResponse, err error)
list_placement_groups(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PlacementGroupCollection> listPlacementGroups(ListPlacementGroupsOptions listPlacementGroupsOptions)
listPlacementGroups(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.placement-group.placement-group.list

  • is.placement-group.placement-group.read

Auditing

Calling this method generates the following auditing event.

  • is.placement-group.placement-group.read

Create a placement group

This request creates a new placement group

This request creates a new placement group.

This request creates a new placement group.

This request creates a new placement group.

This request creates a new placement group.

POST /placement_groups
(vpc *VpcV1) CreatePlacementGroup(createPlacementGroupOptions *CreatePlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreatePlacementGroupWithContext(ctx context.Context, createPlacementGroupOptions *CreatePlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error)
create_placement_group(
        self,
        strategy: str,
        *,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PlacementGroup> createPlacementGroup(CreatePlacementGroupOptions createPlacementGroupOptions)
createPlacementGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.placement-group.placement-group.create

Auditing

Calling this method generates the following auditing event.

  • is.placement-group.placement-group.create

Delete a placement group

This request deletes a placement group. This operation cannot be reversed. For this request to succeed, the placement group must not be associated with an instance.

This request deletes a placement group. This operation cannot be reversed. For this request to succeed, the placement group must not be associated with an instance.

This request deletes a placement group. This operation cannot be reversed. For this request to succeed, the placement group must not be associated with an instance.

This request deletes a placement group. This operation cannot be reversed. For this request to succeed, the placement group must not be associated with an instance.

This request deletes a placement group. This operation cannot be reversed. For this request to succeed, the placement group must not be associated with an instance.

DELETE /placement_groups/{id}
(vpc *VpcV1) DeletePlacementGroup(deletePlacementGroupOptions *DeletePlacementGroupOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeletePlacementGroupWithContext(ctx context.Context, deletePlacementGroupOptions *DeletePlacementGroupOptions) (response *core.DetailedResponse, err error)
delete_placement_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deletePlacementGroup(DeletePlacementGroupOptions deletePlacementGroupOptions)
deletePlacementGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.placement-group.placement-group.delete

Auditing

Calling this method generates the following auditing event.

  • is.placement-group.placement-group.delete

Retrieve a placement group

This request retrieves a single placement group specified by identifier in the URL.

This request retrieves a single placement group specified by identifier in the URL.

This request retrieves a single placement group specified by identifier in the URL.

This request retrieves a single placement group specified by identifier in the URL.

This request retrieves a single placement group specified by identifier in the URL.

GET /placement_groups/{id}
(vpc *VpcV1) GetPlacementGroup(getPlacementGroupOptions *GetPlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetPlacementGroupWithContext(ctx context.Context, getPlacementGroupOptions *GetPlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error)
get_placement_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PlacementGroup> getPlacementGroup(GetPlacementGroupOptions getPlacementGroupOptions)
getPlacementGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.placement-group.placement-group.read

Auditing

Calling this method generates the following auditing event.

  • is.placement-group.placement-group.read

Update a placement group

This request updates a placement group with the information provided placement group patch. The placement group patch object is structured in the same way as a retrieved placement group and contains only the information to be updated.

This request updates a placement group with the information provided placement group patch. The placement group patch object is structured in the same way as a retrieved placement group and contains only the information to be updated.

This request updates a placement group with the information provided placement group patch. The placement group patch object is structured in the same way as a retrieved placement group and contains only the information to be updated.

This request updates a placement group with the information provided placement group patch. The placement group patch object is structured in the same way as a retrieved placement group and contains only the information to be updated.

This request updates a placement group with the information provided placement group patch. The placement group patch object is structured in the same way as a retrieved placement group and contains only the information to be updated.

PATCH /placement_groups/{id}
(vpc *VpcV1) UpdatePlacementGroup(updatePlacementGroupOptions *UpdatePlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdatePlacementGroupWithContext(ctx context.Context, updatePlacementGroupOptions *UpdatePlacementGroupOptions) (result *PlacementGroup, response *core.DetailedResponse, err error)
update_placement_group(
        self,
        id: str,
        placement_group_patch: 'PlacementGroupPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PlacementGroup> updatePlacementGroup(UpdatePlacementGroupOptions updatePlacementGroupOptions)
updatePlacementGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.placement-group.placement-group.update

Auditing

Calling this method generates the following auditing event.

  • is.placement-group.placement-group.update

List all bare metal server profiles

This request lists all bare metal server profiles available in the region. A bare metal server profile specifies the performance characteristics and pricing model for a bare metal server.

This request lists all bare metal server profiles available in the region. A bare metal server profile specifies the performance characteristics and pricing model for a bare metal server.

This request lists all bare metal server profiles available in the region. A bare metal server profile specifies the performance characteristics and pricing model for a bare metal server.

This request lists all bare metal server profiles available in the region. A bare metal server profile specifies the performance characteristics and pricing model for a bare metal server.

This request lists all bare metal server profiles available in the region. A bare metal server profile specifies the performance characteristics and pricing model for a bare metal server.

GET /bare_metal_server/profiles
(vpc *VpcV1) ListBareMetalServerProfiles(listBareMetalServerProfilesOptions *ListBareMetalServerProfilesOptions) (result *BareMetalServerProfileCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBareMetalServerProfilesWithContext(ctx context.Context, listBareMetalServerProfilesOptions *ListBareMetalServerProfilesOptions) (result *BareMetalServerProfileCollection, response *core.DetailedResponse, err error)
list_bare_metal_server_profiles(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerProfileCollection> listBareMetalServerProfiles(ListBareMetalServerProfilesOptions listBareMetalServerProfilesOptions)
listBareMetalServerProfiles(params)

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.profile.read

Retrieve a bare metal server profile

This request retrieves a single bare metal server profile specified by the name in the URL.

This request retrieves a single bare metal server profile specified by the name in the URL.

This request retrieves a single bare metal server profile specified by the name in the URL.

This request retrieves a single bare metal server profile specified by the name in the URL.

This request retrieves a single bare metal server profile specified by the name in the URL.

GET /bare_metal_server/profiles/{name}
(vpc *VpcV1) GetBareMetalServerProfile(getBareMetalServerProfileOptions *GetBareMetalServerProfileOptions) (result *BareMetalServerProfile, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBareMetalServerProfileWithContext(ctx context.Context, getBareMetalServerProfileOptions *GetBareMetalServerProfileOptions) (result *BareMetalServerProfile, response *core.DetailedResponse, err error)
get_bare_metal_server_profile(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerProfile> getBareMetalServerProfile(GetBareMetalServerProfileOptions getBareMetalServerProfileOptions)
getBareMetalServerProfile(params)

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.profile.read

List all bare metal servers

This request lists all bare metal servers in the region.

This request lists all bare metal servers in the region.

This request lists all bare metal servers in the region.

This request lists all bare metal servers in the region.

This request lists all bare metal servers in the region.

GET /bare_metal_servers
(vpc *VpcV1) ListBareMetalServers(listBareMetalServersOptions *ListBareMetalServersOptions) (result *BareMetalServerCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBareMetalServersWithContext(ctx context.Context, listBareMetalServersOptions *ListBareMetalServersOptions) (result *BareMetalServerCollection, response *core.DetailedResponse, err error)
list_bare_metal_servers(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        name: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_crn: Optional[str] = None,
        vpc_name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerCollection> listBareMetalServers(ListBareMetalServersOptions listBareMetalServersOptions)
listBareMetalServers(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.list

  • is.bare-metal-server.bare-metal-server.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.bare-metal-server.read

Create a bare metal server

This request provisions a new bare metal server from a prototype object. The prototype object is structured in the same way as a retrieved bare metal server, and contains the information necessary to provision the new bare metal server. The bare metal server is automatically started.

This request provisions a new bare metal server from a prototype object. The prototype object is structured in the same way as a retrieved bare metal server, and contains the information necessary to provision the new bare metal server. The bare metal server is automatically started.

This request provisions a new bare metal server from a prototype object. The prototype object is structured in the same way as a retrieved bare metal server, and contains the information necessary to provision the new bare metal server. The bare metal server is automatically started.

This request provisions a new bare metal server from a prototype object. The prototype object is structured in the same way as a retrieved bare metal server, and contains the information necessary to provision the new bare metal server. The bare metal server is automatically started.

This request provisions a new bare metal server from a prototype object. The prototype object is structured in the same way as a retrieved bare metal server, and contains the information necessary to provision the new bare metal server. The bare metal server is automatically started.

POST /bare_metal_servers
(vpc *VpcV1) CreateBareMetalServer(createBareMetalServerOptions *CreateBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateBareMetalServerWithContext(ctx context.Context, createBareMetalServerOptions *CreateBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error)
create_bare_metal_server(
        self,
        bare_metal_server_prototype: 'BareMetalServerPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServer> createBareMetalServer(CreateBareMetalServerOptions createBareMetalServerOptions)
createBareMetalServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.create

  • is.subnet.subnet.operate

    Required for each subnet with an existing reserved IP being attached to a bare metal server network interface or to a virtual network interface

  • is.subnet.subnet.update

    Required for each subnet where a new reserved IP is specified on a bare metal server network interface or on a virtual network interface

  • is.security-group.security-group.operate

    Required for bare metal server network interfaces, or for bare metal server network attachments that specify a new virtual network interface

  • is.vpc.vpc.operate

  • is.key.key.operate

  • is.image.image.operate

  • is.bare-metal-server.bare-metal-server.ip-spoofing

    Required when allow_ip_spoofing is true on any bare metal server network interface

  • is.bare-metal-server.bare-metal-server.infrastructure-nat

    Required when enable_infrastructure_nat is false on any bare metal server network interface

  • is.virtual-network-interface.virtual-network-interface.create

    Required for bare metal server network attachments that specify a new virtual network interface

  • is.virtual-network-interface.virtual-network-interface.manage-infrastructure-nat

    Required for bare metal server network attachments that specify a new virtual network interface with enable_infrastructure_nat set to false

  • is.virtual-network-interface.virtual-network-interface.manage-ip-spoofing

    Required for bare metal server network attachments that specify a new virtual network interface with allow_ip_spoofing set to true

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.virtual-network-interface.virtual-network-interface.create

    Generated for each virtual network interface created

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated for:

    • each virtual network interface being attached to a bare metal server network attachment
    • each virtual network interface for each reserved IP being attached to it
    • each virtual network interface for each security group being attached to it

  • is.bare-metal-server.network-attachment.attach

    Generated for each virtual network interface being attached to a bare metal server network attachment

  • is.bare-metal-server.bare-metal-server.create

  • is.bare-metal-server.network-attachment.create

    Generated for each bare metal server network attachment created

  • is.bare-metal-server.network-interface.create

    Generated for each bare metal server network interface created

  • is.bare-metal-server.network-interface.attach

    Generated for each resource being attached to a bare metal server network interface:

    • reserved IPs
    • security groups

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP being attached to:

    • a bare metal server network interface, or
    • a virtual network interface

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created

  • is.security-group.security-group.attach

    Generated for each security group being attached to:

    • a bare metal server network interface, or
    • a new virtual network interface

  • is.subnet.subnet.update

    Generated for each reserved IP created

Retrieve the console WebSocket for a bare metal server

This retrieves a WebSocket providing a console for the bare metal server. An access_token must first be created using the console_access_token API. The serial WebSocket provides a TTY based interface. The vnc WebSocket provides a VNC based graphical interface.

GET /bare_metal_servers/{bare_metal_server_id}/console

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

  • is.bare-metal-server.bare-metal-server.console

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.console.read

Create a console access token for a bare metal server

This request creates a new single-use console access token for a bare metal server. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given bare metal server at a time.

This request creates a new single-use console access token for a bare metal server. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given bare metal server at a time.

This request creates a new single-use console access token for a bare metal server. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given bare metal server at a time.

This request creates a new single-use console access token for a bare metal server. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given bare metal server at a time.

This request creates a new single-use console access token for a bare metal server. All console configuration is provided at token create time, and the token is subsequently used in the access_token query parameter for the WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid for a given bare metal server at a time.

POST /bare_metal_servers/{bare_metal_server_id}/console_access_token
(vpc *VpcV1) CreateBareMetalServerConsoleAccessToken(createBareMetalServerConsoleAccessTokenOptions *CreateBareMetalServerConsoleAccessTokenOptions) (result *BareMetalServerConsoleAccessToken, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateBareMetalServerConsoleAccessTokenWithContext(ctx context.Context, createBareMetalServerConsoleAccessTokenOptions *CreateBareMetalServerConsoleAccessTokenOptions) (result *BareMetalServerConsoleAccessToken, response *core.DetailedResponse, err error)
create_bare_metal_server_console_access_token(
        self,
        bare_metal_server_id: str,
        console_type: str,
        *,
        force: Optional[bool] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerConsoleAccessToken> createBareMetalServerConsoleAccessToken(CreateBareMetalServerConsoleAccessTokenOptions createBareMetalServerConsoleAccessTokenOptions)
createBareMetalServerConsoleAccessToken(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

  • is.bare-metal-server.bare-metal-server.console

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.console.read

List all disks on a bare metal server

This request lists all disks on a bare metal server. A disk is a block device that is locally attached to the physical server. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on a bare metal server. A disk is a block device that is locally attached to the physical server. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on a bare metal server. A disk is a block device that is locally attached to the physical server. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on a bare metal server. A disk is a block device that is locally attached to the physical server. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

This request lists all disks on a bare metal server. A disk is a block device that is locally attached to the physical server. By default, the listed disks are sorted by their created_at property values, with the newest disk first.

GET /bare_metal_servers/{bare_metal_server_id}/disks
(vpc *VpcV1) ListBareMetalServerDisks(listBareMetalServerDisksOptions *ListBareMetalServerDisksOptions) (result *BareMetalServerDiskCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBareMetalServerDisksWithContext(ctx context.Context, listBareMetalServerDisksOptions *ListBareMetalServerDisksOptions) (result *BareMetalServerDiskCollection, response *core.DetailedResponse, err error)
list_bare_metal_server_disks(
        self,
        bare_metal_server_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerDiskCollection> listBareMetalServerDisks(ListBareMetalServerDisksOptions listBareMetalServerDisksOptions)
listBareMetalServerDisks(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.disk.read

Retrieve a bare metal server disk

This request retrieves a single disk specified by the identifier in the URL.

This request retrieves a single disk specified by the identifier in the URL.

This request retrieves a single disk specified by the identifier in the URL.

This request retrieves a single disk specified by the identifier in the URL.

This request retrieves a single disk specified by the identifier in the URL.

GET /bare_metal_servers/{bare_metal_server_id}/disks/{id}
(vpc *VpcV1) GetBareMetalServerDisk(getBareMetalServerDiskOptions *GetBareMetalServerDiskOptions) (result *BareMetalServerDisk, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBareMetalServerDiskWithContext(ctx context.Context, getBareMetalServerDiskOptions *GetBareMetalServerDiskOptions) (result *BareMetalServerDisk, response *core.DetailedResponse, err error)
get_bare_metal_server_disk(
        self,
        bare_metal_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerDisk> getBareMetalServerDisk(GetBareMetalServerDiskOptions getBareMetalServerDiskOptions)
getBareMetalServerDisk(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.disk.read

Update a bare metal server disk

This request updates the bare metal server disk with the information in a provided patch.

This request updates the bare metal server disk with the information in a provided patch.

This request updates the bare metal server disk with the information in a provided patch.

This request updates the bare metal server disk with the information in a provided patch.

This request updates the bare metal server disk with the information in a provided patch.

PATCH /bare_metal_servers/{bare_metal_server_id}/disks/{id}
(vpc *VpcV1) UpdateBareMetalServerDisk(updateBareMetalServerDiskOptions *UpdateBareMetalServerDiskOptions) (result *BareMetalServerDisk, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateBareMetalServerDiskWithContext(ctx context.Context, updateBareMetalServerDiskOptions *UpdateBareMetalServerDiskOptions) (result *BareMetalServerDisk, response *core.DetailedResponse, err error)
update_bare_metal_server_disk(
        self,
        bare_metal_server_id: str,
        id: str,
        bare_metal_server_disk_patch: 'BareMetalServerDiskPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerDisk> updateBareMetalServerDisk(UpdateBareMetalServerDiskOptions updateBareMetalServerDiskOptions)
updateBareMetalServerDisk(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.disk.update

List all network attachments on a bare metal server

This request lists all network attachments on a bare metal server. A bare metal server network attachment is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all network attachments on a bare metal server. A bare metal server network attachment is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all network attachments on a bare metal server. A bare metal server network attachment is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all network attachments on a bare metal server. A bare metal server network attachment is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all network attachments on a bare metal server. A bare metal server network attachment is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

The network attachments will be sorted by their created_at property values, with newest network attachments first. Network attachments with identical created_at property values will in turn be sorted by ascending name property values.

GET /bare_metal_servers/{bare_metal_server_id}/network_attachments
(vpc *VpcV1) ListBareMetalServerNetworkAttachments(listBareMetalServerNetworkAttachmentsOptions *ListBareMetalServerNetworkAttachmentsOptions) (result *BareMetalServerNetworkAttachmentCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBareMetalServerNetworkAttachmentsWithContext(ctx context.Context, listBareMetalServerNetworkAttachmentsOptions *ListBareMetalServerNetworkAttachmentsOptions) (result *BareMetalServerNetworkAttachmentCollection, response *core.DetailedResponse, err error)
list_bare_metal_server_network_attachments(
        self,
        bare_metal_server_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerNetworkAttachmentCollection> listBareMetalServerNetworkAttachments(ListBareMetalServerNetworkAttachmentsOptions listBareMetalServerNetworkAttachmentsOptions)
listBareMetalServerNetworkAttachments(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.network-attachment.read

Create a network attachment on a bare metal server

This request creates a new bare metal server network attachment from a bare metal server network attachment prototype object. The prototype object is structured in the same way as a retrieved bare metal server network attachment, and contains the information necessary to create the new bare metal server network attachment.

This request creates a new bare metal server network attachment from a bare metal server network attachment prototype object. The prototype object is structured in the same way as a retrieved bare metal server network attachment, and contains the information necessary to create the new bare metal server network attachment.

This request creates a new bare metal server network attachment from a bare metal server network attachment prototype object. The prototype object is structured in the same way as a retrieved bare metal server network attachment, and contains the information necessary to create the new bare metal server network attachment.

This request creates a new bare metal server network attachment from a bare metal server network attachment prototype object. The prototype object is structured in the same way as a retrieved bare metal server network attachment, and contains the information necessary to create the new bare metal server network attachment.

This request creates a new bare metal server network attachment from a bare metal server network attachment prototype object. The prototype object is structured in the same way as a retrieved bare metal server network attachment, and contains the information necessary to create the new bare metal server network attachment.

POST /bare_metal_servers/{bare_metal_server_id}/network_attachments
(vpc *VpcV1) CreateBareMetalServerNetworkAttachment(createBareMetalServerNetworkAttachmentOptions *CreateBareMetalServerNetworkAttachmentOptions) (result BareMetalServerNetworkAttachmentIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateBareMetalServerNetworkAttachmentWithContext(ctx context.Context, createBareMetalServerNetworkAttachmentOptions *CreateBareMetalServerNetworkAttachmentOptions) (result BareMetalServerNetworkAttachmentIntf, response *core.DetailedResponse, err error)
create_bare_metal_server_network_attachment(
        self,
        bare_metal_server_id: str,
        bare_metal_server_network_attachment_prototype: 'BareMetalServerNetworkAttachmentPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerNetworkAttachment> createBareMetalServerNetworkAttachment(CreateBareMetalServerNetworkAttachmentOptions createBareMetalServerNetworkAttachmentOptions)
createBareMetalServerNetworkAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.update

  • is.security-group.security-group.operate

    Required for bare metal server network attachments that specify a new virtual network interface

  • is.subnet.subnet.operate

    Required for bare metal server network attachments that specify a new virtual network interface and an existing reserved IP on a subnet

  • is.subnet.subnet.update

    Required for bare metal server network attachments that specify a new virtual network interface and a new reserved IP on a subnet

  • is.virtual-network-interface.virtual-network-interface.create

    Required for bare metal server network attachments that specify a new virtual network interface

  • is.virtual-network-interface.virtual-network-interface.manage-infrastructure-nat

    Required for bare metal server network attachments that specify a new virtual network interface with enable_infrastructure_nat set to false

  • is.virtual-network-interface.virtual-network-interface.manage-ip-spoofing

    Required for bare metal server network attachments that specify a new virtual network interface with allow_ip_spoofing set to true

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.virtual-network-interface.virtual-network-interface.create

    Generated for each virtual network interface created

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated for:

    • each virtual network interface being attached to a bare metal server network attachment
    • each virtual network interface for each reserved IP being attached to it
    • each virtual network interface for each security group being attached to it

  • is.bare-metal-server.network-attachment.attach

    Generated for each virtual network interface being attached to a bare metal server network attachment

  • is.bare-metal-server.network-attachment.create

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP being attached to a new virtual network interface

  • is.security-group.security-group.attach

    Generated for each security group being attached to a new virtual network interface

  • is.subnet.subnet.update

    Generated for each reserved IP created

Delete a bare metal server network attachment

This request deletes a bare metal server network attachment. This operation cannot be reversed. Any floating IPs associated with the bare metal server network attachment are implicitly disassociated.

The bare metal server's primary network attachment cannot be deleted.

This request deletes a bare metal server network attachment. This operation cannot be reversed. Any floating IPs associated with the bare metal server network attachment are implicitly disassociated.

The bare metal server's primary network attachment cannot be deleted.

This request deletes a bare metal server network attachment. This operation cannot be reversed. Any floating IPs associated with the bare metal server network attachment are implicitly disassociated.

The bare metal server's primary network attachment cannot be deleted.

This request deletes a bare metal server network attachment. This operation cannot be reversed. Any floating IPs associated with the bare metal server network attachment are implicitly disassociated.

The bare metal server's primary network attachment cannot be deleted.

This request deletes a bare metal server network attachment. This operation cannot be reversed. Any floating IPs associated with the bare metal server network attachment are implicitly disassociated.

The bare metal server's primary network attachment cannot be deleted.

DELETE /bare_metal_servers/{bare_metal_server_id}/network_attachments/{id}
(vpc *VpcV1) DeleteBareMetalServerNetworkAttachment(deleteBareMetalServerNetworkAttachmentOptions *DeleteBareMetalServerNetworkAttachmentOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteBareMetalServerNetworkAttachmentWithContext(ctx context.Context, deleteBareMetalServerNetworkAttachmentOptions *DeleteBareMetalServerNetworkAttachmentOptions) (response *core.DetailedResponse, err error)
delete_bare_metal_server_network_attachment(
        self,
        bare_metal_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteBareMetalServerNetworkAttachment(DeleteBareMetalServerNetworkAttachmentOptions deleteBareMetalServerNetworkAttachmentOptions)
deleteBareMetalServerNetworkAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.update

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.bare-metal-server.network-attachment.delete

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated for the attached virtual network interface, and also generated for each reserved IP that was attached to the virtual network interface if the virtual network interface had auto_delete set to true

  • is.virtual-network-interface.virtual-network-interface.delete

    Generated when the virtual network interface had auto_delete set to true

  • is.floating-ip.floating-ip.detach

    Generated for each floating IP that was attached to a virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP that was attached to a virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP that had auto_delete set to true that was attached to a virtual network interface that had auto_delete set to true

  • is.subnet.subnet.update

    Generated for each reserved IP that had auto_delete set to true that was attached to a virtual network interface that had auto_delete set to true

  • is.security-group.security-group.detach

    Generated for each security group that was attached to a virtual network interface that had auto_delete set to true

Retrieve a bare metal server network attachment

This request retrieves a single bare metal server network attachment specified by the identifier in the URL.

This request retrieves a single bare metal server network attachment specified by the identifier in the URL.

This request retrieves a single bare metal server network attachment specified by the identifier in the URL.

This request retrieves a single bare metal server network attachment specified by the identifier in the URL.

This request retrieves a single bare metal server network attachment specified by the identifier in the URL.

GET /bare_metal_servers/{bare_metal_server_id}/network_attachments/{id}
(vpc *VpcV1) GetBareMetalServerNetworkAttachment(getBareMetalServerNetworkAttachmentOptions *GetBareMetalServerNetworkAttachmentOptions) (result BareMetalServerNetworkAttachmentIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBareMetalServerNetworkAttachmentWithContext(ctx context.Context, getBareMetalServerNetworkAttachmentOptions *GetBareMetalServerNetworkAttachmentOptions) (result BareMetalServerNetworkAttachmentIntf, response *core.DetailedResponse, err error)
get_bare_metal_server_network_attachment(
        self,
        bare_metal_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerNetworkAttachment> getBareMetalServerNetworkAttachment(GetBareMetalServerNetworkAttachmentOptions getBareMetalServerNetworkAttachmentOptions)
getBareMetalServerNetworkAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.network-attachment.read

Update a bare metal server network attachment

This request updates a bare metal server network attachment with the information provided in a bare metal server network attachment patch object. The bare metal server network attachment patch object is structured in the same way as a retrieved bare metal server network attachment and contains only the information to be updated.

This request updates a bare metal server network attachment with the information provided in a bare metal server network attachment patch object. The bare metal server network attachment patch object is structured in the same way as a retrieved bare metal server network attachment and contains only the information to be updated.

This request updates a bare metal server network attachment with the information provided in a bare metal server network attachment patch object. The bare metal server network attachment patch object is structured in the same way as a retrieved bare metal server network attachment and contains only the information to be updated.

This request updates a bare metal server network attachment with the information provided in a bare metal server network attachment patch object. The bare metal server network attachment patch object is structured in the same way as a retrieved bare metal server network attachment and contains only the information to be updated.

This request updates a bare metal server network attachment with the information provided in a bare metal server network attachment patch object. The bare metal server network attachment patch object is structured in the same way as a retrieved bare metal server network attachment and contains only the information to be updated.

PATCH /bare_metal_servers/{bare_metal_server_id}/network_attachments/{id}
(vpc *VpcV1) UpdateBareMetalServerNetworkAttachment(updateBareMetalServerNetworkAttachmentOptions *UpdateBareMetalServerNetworkAttachmentOptions) (result BareMetalServerNetworkAttachmentIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateBareMetalServerNetworkAttachmentWithContext(ctx context.Context, updateBareMetalServerNetworkAttachmentOptions *UpdateBareMetalServerNetworkAttachmentOptions) (result BareMetalServerNetworkAttachmentIntf, response *core.DetailedResponse, err error)
update_bare_metal_server_network_attachment(
        self,
        bare_metal_server_id: str,
        id: str,
        bare_metal_server_network_attachment_patch: 'BareMetalServerNetworkAttachmentPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerNetworkAttachment> updateBareMetalServerNetworkAttachment(UpdateBareMetalServerNetworkAttachmentOptions updateBareMetalServerNetworkAttachmentOptions)
updateBareMetalServerNetworkAttachment(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.update

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.network-attachment.update

List all network interfaces on a bare metal server

This request lists all network interfaces on a bare metal server. A bare metal server network interface is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

If this bare metal server has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request lists all network interfaces on a bare metal server. A bare metal server network interface is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

If this bare metal server has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request lists all network interfaces on a bare metal server. A bare metal server network interface is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

If this bare metal server has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request lists all network interfaces on a bare metal server. A bare metal server network interface is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

If this bare metal server has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request lists all network interfaces on a bare metal server. A bare metal server network interface is an abstract representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare metal server.

If this bare metal server has network attachments, each returned network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

GET /bare_metal_servers/{bare_metal_server_id}/network_interfaces
(vpc *VpcV1) ListBareMetalServerNetworkInterfaces(listBareMetalServerNetworkInterfacesOptions *ListBareMetalServerNetworkInterfacesOptions) (result *BareMetalServerNetworkInterfaceCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBareMetalServerNetworkInterfacesWithContext(ctx context.Context, listBareMetalServerNetworkInterfacesOptions *ListBareMetalServerNetworkInterfacesOptions) (result *BareMetalServerNetworkInterfaceCollection, response *core.DetailedResponse, err error)
list_bare_metal_server_network_interfaces(
        self,
        bare_metal_server_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerNetworkInterfaceCollection> listBareMetalServerNetworkInterfaces(ListBareMetalServerNetworkInterfacesOptions listBareMetalServerNetworkInterfacesOptions)
listBareMetalServerNetworkInterfaces(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.network-interface.read

Create a network interface on a bare metal server

This request creates a new bare metal server network interface from a bare metal server network interface prototype object. The prototype object is structured in the same way as a retrieved bare metal server network interface, and contains the information necessary to create the new bare metal server network interface. Any subnet in the bare metal server's VPC may be specified, even if it is already attached to another bare metal server network interface. Addresses on the bare metal server network interface must be within the specified subnet's CIDR blocks.

If this bare metal server has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

This request creates a new bare metal server network interface from a bare metal server network interface prototype object. The prototype object is structured in the same way as a retrieved bare metal server network interface, and contains the information necessary to create the new bare metal server network interface. Any subnet in the bare metal server's VPC may be specified, even if it is already attached to another bare metal server network interface. Addresses on the bare metal server network interface must be within the specified subnet's CIDR blocks.

If this bare metal server has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

This request creates a new bare metal server network interface from a bare metal server network interface prototype object. The prototype object is structured in the same way as a retrieved bare metal server network interface, and contains the information necessary to create the new bare metal server network interface. Any subnet in the bare metal server's VPC may be specified, even if it is already attached to another bare metal server network interface. Addresses on the bare metal server network interface must be within the specified subnet's CIDR blocks.

If this bare metal server has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

This request creates a new bare metal server network interface from a bare metal server network interface prototype object. The prototype object is structured in the same way as a retrieved bare metal server network interface, and contains the information necessary to create the new bare metal server network interface. Any subnet in the bare metal server's VPC may be specified, even if it is already attached to another bare metal server network interface. Addresses on the bare metal server network interface must be within the specified subnet's CIDR blocks.

If this bare metal server has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

This request creates a new bare metal server network interface from a bare metal server network interface prototype object. The prototype object is structured in the same way as a retrieved bare metal server network interface, and contains the information necessary to create the new bare metal server network interface. Any subnet in the bare metal server's VPC may be specified, even if it is already attached to another bare metal server network interface. Addresses on the bare metal server network interface must be within the specified subnet's CIDR blocks.

If this bare metal server has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and new network interfaces are not allowed to be created.

POST /bare_metal_servers/{bare_metal_server_id}/network_interfaces
(vpc *VpcV1) CreateBareMetalServerNetworkInterface(createBareMetalServerNetworkInterfaceOptions *CreateBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateBareMetalServerNetworkInterfaceWithContext(ctx context.Context, createBareMetalServerNetworkInterfaceOptions *CreateBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error)
create_bare_metal_server_network_interface(
        self,
        bare_metal_server_id: str,
        bare_metal_server_network_interface_prototype: 'BareMetalServerNetworkInterfacePrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerNetworkInterface> createBareMetalServerNetworkInterface(CreateBareMetalServerNetworkInterfaceOptions createBareMetalServerNetworkInterfaceOptions)
createBareMetalServerNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.update

  • is.subnet.subnet.operate

    Required for bare metal server network interfaces that specify an existing reserved IP on a subnet

  • is.subnet.subnet.update

    Required for bare metal server network interfaces that specify a new reserved IP on a subnet

  • is.security-group.security-group.operate

  • is.bare-metal-server.bare-metal-server.ip-spoofing

    Required when allow_ip_spoofing is true on any bare metal server network interface

  • is.bare-metal-server.bare-metal-server.infrastructure-nat

    Required when enable_infrastructure_nat is false on any bare metal server network interface

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.bare-metal-server.network-interface.create

  • is.bare-metal-server.network-interface.attach

    Generated for each resource attached to the bare metal server network interface:

    • a security group
    • a reserved IP

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP attached to the bare metal server network interface

  • is.security-group.security-group.attach

    Generated for each security group attached to the bare metal server network interface

  • is.subnet.subnet.update

    Generated for each reserved IP created

Delete a bare metal server network interface

This request deletes a bare metal server network interface. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interface are implicitly disassociated. The primary bare metal server network interface is not allowed to be deleted.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

This request deletes a bare metal server network interface. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interface are implicitly disassociated. The primary bare metal server network interface is not allowed to be deleted.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

This request deletes a bare metal server network interface. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interface are implicitly disassociated. The primary bare metal server network interface is not allowed to be deleted.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

This request deletes a bare metal server network interface. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interface are implicitly disassociated. The primary bare metal server network interface is not allowed to be deleted.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

This request deletes a bare metal server network interface. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interface are implicitly disassociated. The primary bare metal server network interface is not allowed to be deleted.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be deleted.

DELETE /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{id}
(vpc *VpcV1) DeleteBareMetalServerNetworkInterface(deleteBareMetalServerNetworkInterfaceOptions *DeleteBareMetalServerNetworkInterfaceOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteBareMetalServerNetworkInterfaceWithContext(ctx context.Context, deleteBareMetalServerNetworkInterfaceOptions *DeleteBareMetalServerNetworkInterfaceOptions) (response *core.DetailedResponse, err error)
delete_bare_metal_server_network_interface(
        self,
        bare_metal_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteBareMetalServerNetworkInterface(DeleteBareMetalServerNetworkInterfaceOptions deleteBareMetalServerNetworkInterfaceOptions)
deleteBareMetalServerNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.update

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.bare-metal-server.network-interface.delete

  • is.bare-metal-server.network-interface.detach

    Generated for each resource that was attached to this bare metal server network interface:

    • floating IPs
    • reserved IPs
    • security groups

  • is.floating-ip.floating-ip.detach

    Generated for each floating IP that was attached to this bare metal server network interface

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP that was attached to this bare metal server network interface

  • is.security-group.security-group.detach

    Generated for each security group that was attached to this bare metal server network interface

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP that had auto_delete set to true that was attached to this bare metal server network interface

  • is.subnet.subnet.update

    Generated for each reserved IP that had auto_delete set to true that was attached to this bare metal server network interface

Retrieve a bare metal server network interface

This request retrieves a single bare metal server network interface specified by the identifier in the URL.

If this bare metal server has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request retrieves a single bare metal server network interface specified by the identifier in the URL.

If this bare metal server has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request retrieves a single bare metal server network interface specified by the identifier in the URL.

If this bare metal server has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request retrieves a single bare metal server network interface specified by the identifier in the URL.

If this bare metal server has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

This request retrieves a single bare metal server network interface specified by the identifier in the URL.

If this bare metal server has network attachments, the retrieved network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.

GET /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{id}
(vpc *VpcV1) GetBareMetalServerNetworkInterface(getBareMetalServerNetworkInterfaceOptions *GetBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBareMetalServerNetworkInterfaceWithContext(ctx context.Context, getBareMetalServerNetworkInterfaceOptions *GetBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error)
get_bare_metal_server_network_interface(
        self,
        bare_metal_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerNetworkInterface> getBareMetalServerNetworkInterface(GetBareMetalServerNetworkInterfaceOptions getBareMetalServerNetworkInterfaceOptions)
getBareMetalServerNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.network-interface.read

Update a bare metal server network interface

This request updates a bare metal server network interface with the information provided in a bare metal server network interface patch object. The bare metal server network interface patch object is structured in the same way as a retrieved bare metal server network interface and needs to contain only the information to be updated.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

This request updates a bare metal server network interface with the information provided in a bare metal server network interface patch object. The bare metal server network interface patch object is structured in the same way as a retrieved bare metal server network interface and needs to contain only the information to be updated.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

This request updates a bare metal server network interface with the information provided in a bare metal server network interface patch object. The bare metal server network interface patch object is structured in the same way as a retrieved bare metal server network interface and needs to contain only the information to be updated.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

This request updates a bare metal server network interface with the information provided in a bare metal server network interface patch object. The bare metal server network interface patch object is structured in the same way as a retrieved bare metal server network interface and needs to contain only the information to be updated.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

This request updates a bare metal server network interface with the information provided in a bare metal server network interface patch object. The bare metal server network interface patch object is structured in the same way as a retrieved bare metal server network interface and needs to contain only the information to be updated.

If this bare metal server has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and is not allowed to be updated.

PATCH /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{id}
(vpc *VpcV1) UpdateBareMetalServerNetworkInterface(updateBareMetalServerNetworkInterfaceOptions *UpdateBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateBareMetalServerNetworkInterfaceWithContext(ctx context.Context, updateBareMetalServerNetworkInterfaceOptions *UpdateBareMetalServerNetworkInterfaceOptions) (result BareMetalServerNetworkInterfaceIntf, response *core.DetailedResponse, err error)
update_bare_metal_server_network_interface(
        self,
        bare_metal_server_id: str,
        id: str,
        bare_metal_server_network_interface_patch: 'BareMetalServerNetworkInterfacePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerNetworkInterface> updateBareMetalServerNetworkInterface(UpdateBareMetalServerNetworkInterfaceOptions updateBareMetalServerNetworkInterfaceOptions)
updateBareMetalServerNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.update

  • is.bare-metal-server.bare-metal-server.ip-spoofing

    Required when allow_ip_spoofing is changed

  • is.bare-metal-server.bare-metal-server.infrastructure-nat

    Required when enable_infrastructure_nat is changed

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.network-interface.update

List all floating IPs associated with a bare metal server network interface

This request lists all floating IPs associated with a bare metal server network interface.

This request lists all floating IPs associated with a bare metal server network interface.

This request lists all floating IPs associated with a bare metal server network interface.

This request lists all floating IPs associated with a bare metal server network interface.

This request lists all floating IPs associated with a bare metal server network interface.

GET /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/floating_ips
(vpc *VpcV1) ListBareMetalServerNetworkInterfaceFloatingIps(listBareMetalServerNetworkInterfaceFloatingIpsOptions *ListBareMetalServerNetworkInterfaceFloatingIpsOptions) (result *FloatingIPUnpaginatedCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBareMetalServerNetworkInterfaceFloatingIpsWithContext(ctx context.Context, listBareMetalServerNetworkInterfaceFloatingIpsOptions *ListBareMetalServerNetworkInterfaceFloatingIpsOptions) (result *FloatingIPUnpaginatedCollection, response *core.DetailedResponse, err error)
list_bare_metal_server_network_interface_floating_ips(
        self,
        bare_metal_server_id: str,
        network_interface_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIPUnpaginatedCollection> listBareMetalServerNetworkInterfaceFloatingIps(ListBareMetalServerNetworkInterfaceFloatingIpsOptions listBareMetalServerNetworkInterfaceFloatingIpsOptions)
listBareMetalServerNetworkInterfaceFloatingIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

  • is.floating-ip.floating-ip.read

    Required for all floating IPs associated with the bare metal server network interface

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.network-interface.floating-ip.read

Disassociate a floating IP from a bare metal server network interface

This request disassociates the specified floating IP from the specified bare metal server network interface

This request disassociates the specified floating IP from the specified bare metal server network interface.

This request disassociates the specified floating IP from the specified bare metal server network interface.

This request disassociates the specified floating IP from the specified bare metal server network interface.

This request disassociates the specified floating IP from the specified bare metal server network interface.

DELETE /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/floating_ips/{id}
(vpc *VpcV1) RemoveBareMetalServerNetworkInterfaceFloatingIP(removeBareMetalServerNetworkInterfaceFloatingIPOptions *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) RemoveBareMetalServerNetworkInterfaceFloatingIPWithContext(ctx context.Context, removeBareMetalServerNetworkInterfaceFloatingIPOptions *RemoveBareMetalServerNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error)
remove_bare_metal_server_network_interface_floating_ip(
        self,
        bare_metal_server_id: str,
        network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> removeBareMetalServerNetworkInterfaceFloatingIp(RemoveBareMetalServerNetworkInterfaceFloatingIpOptions removeBareMetalServerNetworkInterfaceFloatingIpOptions)
removeBareMetalServerNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

  • is.floating-ip.floating-ip.operate

Auditing

Calling this method generates the following auditing events.

  • is.bare-metal-server.network-interface.detach

  • is.floating-ip.floating-ip.detach

Retrieve associated floating IP

This request retrieves a specified floating IP if it is associated with the bare metal server network interface specified in the URL

This request retrieves a specified floating IP if it is associated with the bare metal server network interface specified in the URL.

This request retrieves a specified floating IP if it is associated with the bare metal server network interface specified in the URL.

This request retrieves a specified floating IP if it is associated with the bare metal server network interface specified in the URL.

This request retrieves a specified floating IP if it is associated with the bare metal server network interface specified in the URL.

GET /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/floating_ips/{id}
(vpc *VpcV1) GetBareMetalServerNetworkInterfaceFloatingIP(getBareMetalServerNetworkInterfaceFloatingIPOptions *GetBareMetalServerNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBareMetalServerNetworkInterfaceFloatingIPWithContext(ctx context.Context, getBareMetalServerNetworkInterfaceFloatingIPOptions *GetBareMetalServerNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
get_bare_metal_server_network_interface_floating_ip(
        self,
        bare_metal_server_id: str,
        network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIP> getBareMetalServerNetworkInterfaceFloatingIp(GetBareMetalServerNetworkInterfaceFloatingIpOptions getBareMetalServerNetworkInterfaceFloatingIpOptions)
getBareMetalServerNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

  • is.floating-ip.floating-ip.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.network-interface.floating-ip.read

Associate a floating IP with a bare metal server network interface

This request associates the specified floating IP with the specified bare metal server network interface. If enable_infrastructure_nat is false, this adds the IP to any existing associations. If enable_infrastructure_nat is true, this replaces any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the bare metal server

A request body is not required, and if provided, is ignored.

This request associates the specified floating IP with the specified bare metal server network interface. If enable_infrastructure_nat is false, this adds the IP to any existing associations. If enable_infrastructure_nat is true, this replaces any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the bare metal server

A request body is not required, and if provided, is ignored.

This request associates the specified floating IP with the specified bare metal server network interface. If enable_infrastructure_nat is false, this adds the IP to any existing associations. If enable_infrastructure_nat is true, this replaces any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the bare metal server

A request body is not required, and if provided, is ignored.

This request associates the specified floating IP with the specified bare metal server network interface. If enable_infrastructure_nat is false, this adds the IP to any existing associations. If enable_infrastructure_nat is true, this replaces any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the bare metal server

A request body is not required, and if provided, is ignored.

This request associates the specified floating IP with the specified bare metal server network interface. If enable_infrastructure_nat is false, this adds the IP to any existing associations. If enable_infrastructure_nat is true, this replaces any existing association.

The existing floating IP must:

  • not be required by another resource, such as a public gateway
  • be in the same zone as the bare metal server

A request body is not required, and if provided, is ignored.

PUT /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/floating_ips/{id}
(vpc *VpcV1) AddBareMetalServerNetworkInterfaceFloatingIP(addBareMetalServerNetworkInterfaceFloatingIPOptions *AddBareMetalServerNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) AddBareMetalServerNetworkInterfaceFloatingIPWithContext(ctx context.Context, addBareMetalServerNetworkInterfaceFloatingIPOptions *AddBareMetalServerNetworkInterfaceFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
add_bare_metal_server_network_interface_floating_ip(
        self,
        bare_metal_server_id: str,
        network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIP> addBareMetalServerNetworkInterfaceFloatingIp(AddBareMetalServerNetworkInterfaceFloatingIpOptions addBareMetalServerNetworkInterfaceFloatingIpOptions)
addBareMetalServerNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

  • is.floating-ip.floating-ip.operate

Auditing

Calling this method generates the following auditing events.

  • is.bare-metal-server.network-interface.attach

  • is.floating-ip.floating-ip.attach

List the primary reserved IP for a bare metal server network interface

This request lists the primary reserved IP for a bare metal server network interface.

This request lists the primary reserved IP for a bare metal server network interface.

This request lists the primary reserved IP for a bare metal server network interface.

This request lists the primary reserved IP for a bare metal server network interface.

This request lists the primary reserved IP for a bare metal server network interface.

GET /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/ips
(vpc *VpcV1) ListBareMetalServerNetworkInterfaceIps(listBareMetalServerNetworkInterfaceIpsOptions *ListBareMetalServerNetworkInterfaceIpsOptions) (result *ReservedIPCollectionBareMetalServerNetworkInterfaceContext, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBareMetalServerNetworkInterfaceIpsWithContext(ctx context.Context, listBareMetalServerNetworkInterfaceIpsOptions *ListBareMetalServerNetworkInterfaceIpsOptions) (result *ReservedIPCollectionBareMetalServerNetworkInterfaceContext, response *core.DetailedResponse, err error)
list_bare_metal_server_network_interface_ips(
        self,
        bare_metal_server_id: str,
        network_interface_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIPCollectionBareMetalServerNetworkInterfaceContext> listBareMetalServerNetworkInterfaceIps(ListBareMetalServerNetworkInterfaceIpsOptions listBareMetalServerNetworkInterfaceIpsOptions)
listBareMetalServerNetworkInterfaceIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

  • is.subnet.subnet.read

    Required for the subnet attached to the bare metal server network interface

Auditing

Calling this method generates the following auditing event, depending on any listed conditions.

  • is.subnet.reserved-ip.read

    Generated for each reserved IP in the list.

Retrieve the primary reserved IP

This request retrieves the primary reserved IP for a bare metal server network interface.

This request retrieves the primary reserved IP for a bare metal server network interface.

This request retrieves the primary reserved IP for a bare metal server network interface.

This request retrieves the primary reserved IP for a bare metal server network interface.

This request retrieves the primary reserved IP for a bare metal server network interface.

GET /bare_metal_servers/{bare_metal_server_id}/network_interfaces/{network_interface_id}/ips/{id}
(vpc *VpcV1) GetBareMetalServerNetworkInterfaceIP(getBareMetalServerNetworkInterfaceIPOptions *GetBareMetalServerNetworkInterfaceIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBareMetalServerNetworkInterfaceIPWithContext(ctx context.Context, getBareMetalServerNetworkInterfaceIPOptions *GetBareMetalServerNetworkInterfaceIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
get_bare_metal_server_network_interface_ip(
        self,
        bare_metal_server_id: str,
        network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIP> getBareMetalServerNetworkInterfaceIp(GetBareMetalServerNetworkInterfaceIpOptions getBareMetalServerNetworkInterfaceIpOptions)
getBareMetalServerNetworkInterfaceIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

  • is.subnet.subnet.read

    Required for the subnet attached to the bare metal server network interface

Auditing

Calling this method generates the following auditing event.

  • is.subnet.reserved-ip.read

Delete a bare metal server

This request deletes a bare metal server. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interfaces are implicitly disassociated.

This request deletes a bare metal server. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interfaces are implicitly disassociated.

This request deletes a bare metal server. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interfaces are implicitly disassociated.

This request deletes a bare metal server. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interfaces are implicitly disassociated.

This request deletes a bare metal server. This operation cannot be reversed. Any floating IPs associated with the bare metal server network interfaces are implicitly disassociated.

DELETE /bare_metal_servers/{id}
(vpc *VpcV1) DeleteBareMetalServer(deleteBareMetalServerOptions *DeleteBareMetalServerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteBareMetalServerWithContext(ctx context.Context, deleteBareMetalServerOptions *DeleteBareMetalServerOptions) (response *core.DetailedResponse, err error)
delete_bare_metal_server(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteBareMetalServer(DeleteBareMetalServerOptions deleteBareMetalServerOptions)
deleteBareMetalServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.bare-metal-server.bare-metal-server.delete

  • is.bare-metal-server.network-interface.delete

    Generated for each network interface on the bare metal server

  • is.bare-metal-server.network-interface.detach

    Generated for each network interface on the bare metal server

  • is.bare-metal-server.network-attachment.delete

    Generated for each network attachment on the bare metal server

  • is.bare-metal-server.network-attachment.detach

    Generated for each network attachment on the bare metal server

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated for:

    • each attached virtual network interface
    • each virtual network interface that had auto_delete set to true, for each attached reserved IP

  • is.virtual-network-interface.virtual-network-interface.delete

    Generated for each virtual network interface that had auto_delete set to true

  • is.floating-ip.floating-ip.detach

    Generated for each floating IP that was attached to:

    • a network interface on the bare metal server, or
    • an virtual network interface that had auto_delete set to true

  • is.security-group.security-group.detach

    Generated for each security group that was attached to:

    • a network interface on the bare metal server, or
    • an virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP that was attached to:

    • a network interface on the bare metal server, or
    • an virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP that had auto_delete set to true

  • is.subnet.subnet.update

    Generated for each reserved IP that had auto_delete set to true

Retrieve a bare metal server

This request retrieves a single bare metal server specified by the identifier in the URL.

This request retrieves a single bare metal server specified by the identifier in the URL.

This request retrieves a single bare metal server specified by the identifier in the URL.

This request retrieves a single bare metal server specified by the identifier in the URL.

This request retrieves a single bare metal server specified by the identifier in the URL.

GET /bare_metal_servers/{id}
(vpc *VpcV1) GetBareMetalServer(getBareMetalServerOptions *GetBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBareMetalServerWithContext(ctx context.Context, getBareMetalServerOptions *GetBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error)
get_bare_metal_server(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServer> getBareMetalServer(GetBareMetalServerOptions getBareMetalServerOptions)
getBareMetalServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.read

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.bare-metal-server.read

Update a bare metal server

This request updates a bare metal server with the information in a provided patch. The bare metal server patch object is structured in the same way as a retrieved bare metal server and contains only the information to be updated.

This request updates a bare metal server with the information in a provided patch. The bare metal server patch object is structured in the same way as a retrieved bare metal server and contains only the information to be updated.

This request updates a bare metal server with the information in a provided patch. The bare metal server patch object is structured in the same way as a retrieved bare metal server and contains only the information to be updated.

This request updates a bare metal server with the information in a provided patch. The bare metal server patch object is structured in the same way as a retrieved bare metal server and contains only the information to be updated.

This request updates a bare metal server with the information in a provided patch. The bare metal server patch object is structured in the same way as a retrieved bare metal server and contains only the information to be updated.

PATCH /bare_metal_servers/{id}
(vpc *VpcV1) UpdateBareMetalServer(updateBareMetalServerOptions *UpdateBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateBareMetalServerWithContext(ctx context.Context, updateBareMetalServerOptions *UpdateBareMetalServerOptions) (result *BareMetalServer, response *core.DetailedResponse, err error)
update_bare_metal_server(
        self,
        id: str,
        bare_metal_server_patch: 'BareMetalServerPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServer> updateBareMetalServer(UpdateBareMetalServerOptions updateBareMetalServerOptions)
updateBareMetalServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.update

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.bare-metal-server.update

Retrieve initialization configuration for a bare metal server

This request retrieves configuration used to initialize the bare metal server, such as the image used, SSH keys, and any configured usernames and passwords. These can subsequently be changed on the server and therefore may not be current.

This request retrieves configuration used to initialize the bare metal server, such as the image used, SSH keys, and any configured usernames and passwords. These can subsequently be changed on the server and therefore may not be current.

This request retrieves configuration used to initialize the bare metal server, such as the image used, SSH keys, and any configured usernames and passwords. These can subsequently be changed on the server and therefore may not be current.

This request retrieves configuration used to initialize the bare metal server, such as the image used, SSH keys, and any configured usernames and passwords. These can subsequently be changed on the server and therefore may not be current.

This request retrieves configuration used to initialize the bare metal server, such as the image used, SSH keys, and any configured usernames and passwords. These can subsequently be changed on the server and therefore may not be current.

GET /bare_metal_servers/{id}/initialization
(vpc *VpcV1) GetBareMetalServerInitialization(getBareMetalServerInitializationOptions *GetBareMetalServerInitializationOptions) (result *BareMetalServerInitialization, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBareMetalServerInitializationWithContext(ctx context.Context, getBareMetalServerInitializationOptions *GetBareMetalServerInitializationOptions) (result *BareMetalServerInitialization, response *core.DetailedResponse, err error)
get_bare_metal_server_initialization(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BareMetalServerInitialization> getBareMetalServerInitialization(GetBareMetalServerInitializationOptions getBareMetalServerInitializationOptions)
getBareMetalServerInitialization(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.initialization.read

Restart a bare metal server

This request restarts a bare metal server. It will run immediately regardless of the state of the server.

This request restarts a bare metal server. It will run immediately regardless of the state of the server.

This request restarts a bare metal server. It will run immediately regardless of the state of the server.

This request restarts a bare metal server. It will run immediately regardless of the state of the server.

This request restarts a bare metal server. It will run immediately regardless of the state of the server.

POST /bare_metal_servers/{id}/restart
(vpc *VpcV1) RestartBareMetalServer(restartBareMetalServerOptions *RestartBareMetalServerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) RestartBareMetalServerWithContext(ctx context.Context, restartBareMetalServerOptions *RestartBareMetalServerOptions) (response *core.DetailedResponse, err error)
restart_bare_metal_server(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> restartBareMetalServer(RestartBareMetalServerOptions restartBareMetalServerOptions)
restartBareMetalServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.bare-metal-server.restart

Start a bare metal server

This request starts a bare metal server. It will run immediately provided the server is stopped.

This request starts a bare metal server. It will run immediately provided the server is stopped.

This request starts a bare metal server. It will run immediately provided the server is stopped.

This request starts a bare metal server. It will run immediately provided the server is stopped.

This request starts a bare metal server. It will run immediately provided the server is stopped.

POST /bare_metal_servers/{id}/start
(vpc *VpcV1) StartBareMetalServer(startBareMetalServerOptions *StartBareMetalServerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) StartBareMetalServerWithContext(ctx context.Context, startBareMetalServerOptions *StartBareMetalServerOptions) (response *core.DetailedResponse, err error)
start_bare_metal_server(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> startBareMetalServer(StartBareMetalServerOptions startBareMetalServerOptions)
startBareMetalServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.bare-metal-server.start

Stop a bare metal server

This request stops a bare metal server. It will run immediately provided the server is running. Note: A soft stop may not complete as it relies on the operating system to perform the operation.

This request stops a bare metal server. It will run immediately provided the server is running. Note: A soft stop may not complete as it relies on the operating system to perform the operation.

This request stops a bare metal server. It will run immediately provided the server is running. Note: A soft stop may not complete as it relies on the operating system to perform the operation.

This request stops a bare metal server. It will run immediately provided the server is running. Note: A soft stop may not complete as it relies on the operating system to perform the operation.

This request stops a bare metal server. It will run immediately provided the server is running. Note: A soft stop may not complete as it relies on the operating system to perform the operation.

POST /bare_metal_servers/{id}/stop
(vpc *VpcV1) StopBareMetalServer(stopBareMetalServerOptions *StopBareMetalServerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) StopBareMetalServerWithContext(ctx context.Context, stopBareMetalServerOptions *StopBareMetalServerOptions) (response *core.DetailedResponse, err error)
stop_bare_metal_server(
        self,
        id: str,
        type: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> stopBareMetalServer(StopBareMetalServerOptions stopBareMetalServerOptions)
stopBareMetalServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.bare-metal-server.bare-metal-server.operate

Auditing

Calling this method generates the following auditing event.

  • is.bare-metal-server.bare-metal-server.stop

List all volume profiles

This request lists all volume profiles available in the region. A volume profile specifies the performance characteristics and pricing model for a volume.

This request lists all volume profiles available in the region. A volume profile specifies the performance characteristics and pricing model for a volume.

This request lists all volume profiles available in the region. A volume profile specifies the performance characteristics and pricing model for a volume.

This request lists all volume profiles available in the region. A volume profile specifies the performance characteristics and pricing model for a volume.

This request lists all volume profiles available in the region. A volume profile specifies the performance characteristics and pricing model for a volume.

GET /volume/profiles
(vpc *VpcV1) ListVolumeProfiles(listVolumeProfilesOptions *ListVolumeProfilesOptions) (result *VolumeProfileCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVolumeProfilesWithContext(ctx context.Context, listVolumeProfilesOptions *ListVolumeProfilesOptions) (result *VolumeProfileCollection, response *core.DetailedResponse, err error)
list_volume_profiles(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VolumeProfileCollection> listVolumeProfiles(ListVolumeProfilesOptions listVolumeProfilesOptions)
listVolumeProfiles(params)

Retrieve a volume profile

This request retrieves a single volume profile specified by the name in the URL.

This request retrieves a single volume profile specified by the name in the URL.

This request retrieves a single volume profile specified by the name in the URL.

This request retrieves a single volume profile specified by the name in the URL.

This request retrieves a single volume profile specified by the name in the URL.

GET /volume/profiles/{name}
(vpc *VpcV1) GetVolumeProfile(getVolumeProfileOptions *GetVolumeProfileOptions) (result *VolumeProfile, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVolumeProfileWithContext(ctx context.Context, getVolumeProfileOptions *GetVolumeProfileOptions) (result *VolumeProfile, response *core.DetailedResponse, err error)
get_volume_profile(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VolumeProfile> getVolumeProfile(GetVolumeProfileOptions getVolumeProfileOptions)
getVolumeProfile(params)

List all volumes

This request lists all volumes in the region. Volumes are network-connected block storage devices that may be attached to one or more instances in the same region.

This request lists all volumes in the region. Volumes are network-connected block storage devices that may be attached to one or more instances in the same region.

This request lists all volumes in the region. Volumes are network-connected block storage devices that may be attached to one or more instances in the same region.

This request lists all volumes in the region. Volumes are network-connected block storage devices that may be attached to one or more instances in the same region.

This request lists all volumes in the region. Volumes are network-connected block storage devices that may be attached to one or more instances in the same region.

GET /volumes
(vpc *VpcV1) ListVolumes(listVolumesOptions *ListVolumesOptions) (result *VolumeCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVolumesWithContext(ctx context.Context, listVolumesOptions *ListVolumesOptions) (result *VolumeCollection, response *core.DetailedResponse, err error)
list_volumes(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        name: Optional[str] = None,
        attachment_state: Optional[str] = None,
        encryption: Optional[str] = None,
        operating_system_family: Optional[str] = None,
        operating_system_architecture: Optional[str] = None,
        zone_name: Optional[str] = None,
        tag: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VolumeCollection> listVolumes(ListVolumesOptions listVolumesOptions)
listVolumes(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.volume.volume.read

Auditing

Calling this method generates the following auditing event.

  • is.volume.volume.read

Create a volume

This request creates a new volume from a volume prototype object. The prototype object is structured in the same way as a retrieved volume, and contains the information necessary to create the new volume.

This request creates a new volume from a volume prototype object. The prototype object is structured in the same way as a retrieved volume, and contains the information necessary to create the new volume.

This request creates a new volume from a volume prototype object. The prototype object is structured in the same way as a retrieved volume, and contains the information necessary to create the new volume.

This request creates a new volume from a volume prototype object. The prototype object is structured in the same way as a retrieved volume, and contains the information necessary to create the new volume.

This request creates a new volume from a volume prototype object. The prototype object is structured in the same way as a retrieved volume, and contains the information necessary to create the new volume.

POST /volumes
(vpc *VpcV1) CreateVolume(createVolumeOptions *CreateVolumeOptions) (result *Volume, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVolumeWithContext(ctx context.Context, createVolumeOptions *CreateVolumeOptions) (result *Volume, response *core.DetailedResponse, err error)
create_volume(
        self,
        volume_prototype: 'VolumePrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Volume> createVolume(CreateVolumeOptions createVolumeOptions)
createVolume(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.volume.volume.create

  • is.snapshot.snapshot.operate

    Required when source_snapshot is specified.

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.volume.volume.create

  • is.snapshot.snapshot.operate

    Required when source_snapshot is specified.

Delete a volume

This request deletes a volume. This operation cannot be reversed. For this request to succeed, the volume must not be attached to any instances.

This request deletes a volume. This operation cannot be reversed. For this request to succeed, the volume must not be attached to any instances.

This request deletes a volume. This operation cannot be reversed. For this request to succeed, the volume must not be attached to any instances.

This request deletes a volume. This operation cannot be reversed. For this request to succeed, the volume must not be attached to any instances.

This request deletes a volume. This operation cannot be reversed. For this request to succeed, the volume must not be attached to any instances.

DELETE /volumes/{id}
(vpc *VpcV1) DeleteVolume(deleteVolumeOptions *DeleteVolumeOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVolumeWithContext(ctx context.Context, deleteVolumeOptions *DeleteVolumeOptions) (response *core.DetailedResponse, err error)
delete_volume(
        self,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVolume(DeleteVolumeOptions deleteVolumeOptions)
deleteVolume(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.volume.volume.delete

Auditing

Calling this method generates the following auditing event.

  • is.volume.volume.delete

Retrieve a volume

This request retrieves a single volume specified by the identifier in the URL.

This request retrieves a single volume specified by the identifier in the URL.

This request retrieves a single volume specified by the identifier in the URL.

This request retrieves a single volume specified by the identifier in the URL.

This request retrieves a single volume specified by the identifier in the URL.

GET /volumes/{id}
(vpc *VpcV1) GetVolume(getVolumeOptions *GetVolumeOptions) (result *Volume, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVolumeWithContext(ctx context.Context, getVolumeOptions *GetVolumeOptions) (result *Volume, response *core.DetailedResponse, err error)
get_volume(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Volume> getVolume(GetVolumeOptions getVolumeOptions)
getVolume(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.volume.volume.read

Auditing

Calling this method generates the following auditing event.

  • is.volume.volume.read

Update a volume

This request updates a volume with the information in a provided volume patch. The volume patch object is structured in the same way as a retrieved volume and contains only the information to be updated.

This request updates a volume with the information in a provided volume patch. The volume patch object is structured in the same way as a retrieved volume and contains only the information to be updated.

This request updates a volume with the information in a provided volume patch. The volume patch object is structured in the same way as a retrieved volume and contains only the information to be updated.

This request updates a volume with the information in a provided volume patch. The volume patch object is structured in the same way as a retrieved volume and contains only the information to be updated.

This request updates a volume with the information in a provided volume patch. The volume patch object is structured in the same way as a retrieved volume and contains only the information to be updated.

PATCH /volumes/{id}
(vpc *VpcV1) UpdateVolume(updateVolumeOptions *UpdateVolumeOptions) (result *Volume, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVolumeWithContext(ctx context.Context, updateVolumeOptions *UpdateVolumeOptions) (result *Volume, response *core.DetailedResponse, err error)
update_volume(
        self,
        id: str,
        volume_patch: 'VolumePatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Volume> updateVolume(UpdateVolumeOptions updateVolumeOptions)
updateVolume(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.volume.volume.update

Auditing

Calling this method generates the following auditing event.

  • is.volume.volume.update

List all snapshot consistency groups

This request lists all snapshot consistency groups in the region. A snapshot consistency group is a collection of individual snapshots taken at the same time.

This request lists all snapshot consistency groups in the region. A snapshot consistency group is a collection of individual snapshots taken at the same time.

This request lists all snapshot consistency groups in the region. A snapshot consistency group is a collection of individual snapshots taken at the same time.

This request lists all snapshot consistency groups in the region. A snapshot consistency group is a collection of individual snapshots taken at the same time.

This request lists all snapshot consistency groups in the region. A snapshot consistency group is a collection of individual snapshots taken at the same time.

GET /snapshot_consistency_groups
(vpc *VpcV1) ListSnapshotConsistencyGroups(listSnapshotConsistencyGroupsOptions *ListSnapshotConsistencyGroupsOptions) (result *SnapshotConsistencyGroupCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSnapshotConsistencyGroupsWithContext(ctx context.Context, listSnapshotConsistencyGroupsOptions *ListSnapshotConsistencyGroupsOptions) (result *SnapshotConsistencyGroupCollection, response *core.DetailedResponse, err error)
list_snapshot_consistency_groups(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        name: Optional[str] = None,
        sort: Optional[str] = None,
        backup_policy_plan_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotConsistencyGroupCollection> listSnapshotConsistencyGroups(ListSnapshotConsistencyGroupsOptions listSnapshotConsistencyGroupsOptions)
listSnapshotConsistencyGroups(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.snapshot-consistency-group.snapshot-consistency-group.list

  • is.snapshot-consistency-group.snapshot-consistency-group.read

Auditing

Calling this method generates the following auditing event.

  • is.snapshot-consistency-group.snapshot-consistency-group.read

Create a snapshot consistency group

This request creates a new snapshot consistency group from a snapshot consistency group object. The prototype object is structured in the same way as a retrieved consistency group, and contains the information necessary to provision the new snapshot consistency group.

This request creates a new snapshot consistency group from a snapshot consistency group object. The prototype object is structured in the same way as a retrieved consistency group, and contains the information necessary to provision the new snapshot consistency group.

This request creates a new snapshot consistency group from a snapshot consistency group object. The prototype object is structured in the same way as a retrieved consistency group, and contains the information necessary to provision the new snapshot consistency group.

This request creates a new snapshot consistency group from a snapshot consistency group object. The prototype object is structured in the same way as a retrieved consistency group, and contains the information necessary to provision the new snapshot consistency group.

This request creates a new snapshot consistency group from a snapshot consistency group object. The prototype object is structured in the same way as a retrieved consistency group, and contains the information necessary to provision the new snapshot consistency group.

POST /snapshot_consistency_groups
(vpc *VpcV1) CreateSnapshotConsistencyGroup(createSnapshotConsistencyGroupOptions *CreateSnapshotConsistencyGroupOptions) (result *SnapshotConsistencyGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateSnapshotConsistencyGroupWithContext(ctx context.Context, createSnapshotConsistencyGroupOptions *CreateSnapshotConsistencyGroupOptions) (result *SnapshotConsistencyGroup, response *core.DetailedResponse, err error)
create_snapshot_consistency_group(
        self,
        snapshot_consistency_group_prototype: 'SnapshotConsistencyGroupPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotConsistencyGroup> createSnapshotConsistencyGroup(CreateSnapshotConsistencyGroupOptions createSnapshotConsistencyGroupOptions)
createSnapshotConsistencyGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.snapshot-consistency-group.snapshot-consistency-group.create

  • is.volume.volume.operate

    Required for each source_volume specified.

  • is.instance.instance.operate

    Required for the instance attached to the source volumes.

  • is.snapshot.snapshot.create

    Required when snapshots is specified.

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.snapshot-consistency-group.snapshot-consistency-group.create

  • is.snapshot.snapshot.create

    Generated for each snapshot created

Delete a snapshot consistency group

This request deletes snapshot consistency group. This operation cannot be reversed. If the delete_snapshots_on_delete property is true, all snapshots in the consistency group will also be deleted.

This request deletes snapshot consistency group. This operation cannot be reversed. If the delete_snapshots_on_delete property is true, all snapshots in the consistency group will also be deleted.

This request deletes snapshot consistency group. This operation cannot be reversed. If the delete_snapshots_on_delete property is true, all snapshots in the consistency group will also be deleted.

This request deletes snapshot consistency group. This operation cannot be reversed. If the delete_snapshots_on_delete property is true, all snapshots in the consistency group will also be deleted.

This request deletes snapshot consistency group. This operation cannot be reversed. If the delete_snapshots_on_delete property is true, all snapshots in the consistency group will also be deleted.

DELETE /snapshot_consistency_groups/{id}
(vpc *VpcV1) DeleteSnapshotConsistencyGroup(deleteSnapshotConsistencyGroupOptions *DeleteSnapshotConsistencyGroupOptions) (result *SnapshotConsistencyGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSnapshotConsistencyGroupWithContext(ctx context.Context, deleteSnapshotConsistencyGroupOptions *DeleteSnapshotConsistencyGroupOptions) (result *SnapshotConsistencyGroup, response *core.DetailedResponse, err error)
delete_snapshot_consistency_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotConsistencyGroup> deleteSnapshotConsistencyGroup(DeleteSnapshotConsistencyGroupOptions deleteSnapshotConsistencyGroupOptions)
deleteSnapshotConsistencyGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.snapshot-consistency-group.snapshot-consistency-group.delete

  • is.snapshot.snapshot.delete

    Required when delete_snapshots_on_delete property is true

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.snapshot-consistency-group.snapshot-consistency-group.delete

  • is.snapshot.snapshot.delete

    Generated for each deleted snapshot

Retrieve a snapshot consistency group

This request retrieves a single snapshot consistency group specified by the identifier in the URL.

This request retrieves a single snapshot consistency group specified by the identifier in the URL.

This request retrieves a single snapshot consistency group specified by the identifier in the URL.

This request retrieves a single snapshot consistency group specified by the identifier in the URL.

This request retrieves a single snapshot consistency group specified by the identifier in the URL.

GET /snapshot_consistency_groups/{id}
(vpc *VpcV1) GetSnapshotConsistencyGroup(getSnapshotConsistencyGroupOptions *GetSnapshotConsistencyGroupOptions) (result *SnapshotConsistencyGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSnapshotConsistencyGroupWithContext(ctx context.Context, getSnapshotConsistencyGroupOptions *GetSnapshotConsistencyGroupOptions) (result *SnapshotConsistencyGroup, response *core.DetailedResponse, err error)
get_snapshot_consistency_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotConsistencyGroup> getSnapshotConsistencyGroup(GetSnapshotConsistencyGroupOptions getSnapshotConsistencyGroupOptions)
getSnapshotConsistencyGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.snapshot-consistency-group.snapshot-consistency-group.read

Auditing

Calling this method generates the following auditing event.

  • is.snapshot-consistency-group.snapshot-consistency-group.read

Update a snapshot consistency group

This request updates a snapshot consistency group with the information in a provided snapshot consistency group patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot consistency group and contains only the information to be updated.

This request updates a snapshot consistency group with the information in a provided snapshot consistency group patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot consistency group and contains only the information to be updated.

This request updates a snapshot consistency group with the information in a provided snapshot consistency group patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot consistency group and contains only the information to be updated.

This request updates a snapshot consistency group with the information in a provided snapshot consistency group patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot consistency group and contains only the information to be updated.

This request updates a snapshot consistency group with the information in a provided snapshot consistency group patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot consistency group and contains only the information to be updated.

PATCH /snapshot_consistency_groups/{id}
(vpc *VpcV1) UpdateSnapshotConsistencyGroup(updateSnapshotConsistencyGroupOptions *UpdateSnapshotConsistencyGroupOptions) (result *SnapshotConsistencyGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateSnapshotConsistencyGroupWithContext(ctx context.Context, updateSnapshotConsistencyGroupOptions *UpdateSnapshotConsistencyGroupOptions) (result *SnapshotConsistencyGroup, response *core.DetailedResponse, err error)
update_snapshot_consistency_group(
        self,
        id: str,
        snapshot_consistency_group_patch: 'SnapshotConsistencyGroupPatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotConsistencyGroup> updateSnapshotConsistencyGroup(UpdateSnapshotConsistencyGroupOptions updateSnapshotConsistencyGroupOptions)
updateSnapshotConsistencyGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.snapshot-consistency-group.snapshot-consistency-group.update

Auditing

Calling this method generates the following auditing event.

  • is.snapshot-consistency-group.snapshot-consistency-group.update

Delete a filtered collection of snapshots

This request deletes all snapshots created from a specific source volume

This request deletes all snapshots created from a specific source volume.

This request deletes all snapshots created from a specific source volume.

This request deletes all snapshots created from a specific source volume.

This request deletes all snapshots created from a specific source volume.

DELETE /snapshots
(vpc *VpcV1) DeleteSnapshots(deleteSnapshotsOptions *DeleteSnapshotsOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSnapshotsWithContext(ctx context.Context, deleteSnapshotsOptions *DeleteSnapshotsOptions) (response *core.DetailedResponse, err error)
delete_snapshots(
        self,
        source_volume_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteSnapshots(DeleteSnapshotsOptions deleteSnapshotsOptions)
deleteSnapshots(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.snapshot.snapshot.delete

  • is.snapshot.snapshot-clone.delete

    Generated for each snapshot clone in clones[]

List all snapshots

This request lists all snapshots in the region. A snapshot preserves the data of a volume at the time the snapshot is created.

This request lists all snapshots in the region. A snapshot preserves the data of a volume at the time the snapshot is created.

This request lists all snapshots in the region. A snapshot preserves the data of a volume at the time the snapshot is created.

This request lists all snapshots in the region. A snapshot preserves the data of a volume at the time the snapshot is created.

This request lists all snapshots in the region. A snapshot preserves the data of a volume at the time the snapshot is created.

GET /snapshots
(vpc *VpcV1) ListSnapshots(listSnapshotsOptions *ListSnapshotsOptions) (result *SnapshotCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSnapshotsWithContext(ctx context.Context, listSnapshotsOptions *ListSnapshotsOptions) (result *SnapshotCollection, response *core.DetailedResponse, err error)
list_snapshots(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        tag: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        name: Optional[str] = None,
        source_volume_id: Optional[str] = None,
        source_volume_crn: Optional[str] = None,
        source_image_id: Optional[str] = None,
        source_image_crn: Optional[str] = None,
        sort: Optional[str] = None,
        backup_policy_plan_id: Optional[str] = None,
        copies_id: Optional[str] = None,
        copies_name: Optional[str] = None,
        copies_crn: Optional[str] = None,
        copies_remote_region_name: Optional[str] = None,
        source_snapshot_id: Optional[str] = None,
        source_snapshot_remote_region_name: Optional[str] = None,
        source_volume_remote_region_name: Optional[str] = None,
        source_image_remote_region_name: Optional[str] = None,
        clones_zone_name: Optional[str] = None,
        snapshot_consistency_group_id: Optional[str] = None,
        snapshot_consistency_group_crn: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotCollection> listSnapshots(ListSnapshotsOptions listSnapshotsOptions)
listSnapshots(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot.list

  • is.snapshot.snapshot.read

Auditing

Calling this method generates the following auditing events.

  • is.snapshot.snapshot.read

  • is.snapshot.snapshot-clone.read

Create a snapshot

This request creates a new snapshot from a snapshot prototype object. The prototype object is structured in the same way as a retrieved snapshot, and contains the information necessary to provision the new snapshot.

This request creates a new snapshot from a snapshot prototype object. The prototype object is structured in the same way as a retrieved snapshot, and contains the information necessary to provision the new snapshot.

This request creates a new snapshot from a snapshot prototype object. The prototype object is structured in the same way as a retrieved snapshot, and contains the information necessary to provision the new snapshot.

This request creates a new snapshot from a snapshot prototype object. The prototype object is structured in the same way as a retrieved snapshot, and contains the information necessary to provision the new snapshot.

This request creates a new snapshot from a snapshot prototype object. The prototype object is structured in the same way as a retrieved snapshot, and contains the information necessary to provision the new snapshot.

POST /snapshots
(vpc *VpcV1) CreateSnapshot(createSnapshotOptions *CreateSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateSnapshotWithContext(ctx context.Context, createSnapshotOptions *CreateSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error)
create_snapshot(
        self,
        snapshot_prototype: 'SnapshotPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Snapshot> createSnapshot(CreateSnapshotOptions createSnapshotOptions)
createSnapshot(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot.create

  • is.volume.volume.operate

  • is.instance.instance.operate

    Required for the instance the volume is attached to

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.snapshot.snapshot.create

  • is.snapshot.snapshot.capture

  • is.snapshot.snapshot-clone.create

    Generated for each snapshot clone in clones[]

Delete a snapshot

This request deletes a snapshot. This operation cannot be reversed.

This request deletes a snapshot. This operation cannot be reversed.

This request deletes a snapshot. This operation cannot be reversed.

This request deletes a snapshot. This operation cannot be reversed.

This request deletes a snapshot. This operation cannot be reversed.

DELETE /snapshots/{id}
(vpc *VpcV1) DeleteSnapshot(deleteSnapshotOptions *DeleteSnapshotOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSnapshotWithContext(ctx context.Context, deleteSnapshotOptions *DeleteSnapshotOptions) (response *core.DetailedResponse, err error)
delete_snapshot(
        self,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteSnapshot(DeleteSnapshotOptions deleteSnapshotOptions)
deleteSnapshot(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.snapshot.snapshot.delete

  • is.snapshot.snapshot-clone.delete

    Generated for each snapshot clone in clones[]

Retrieve a snapshot

This request retrieves a single snapshot specified by the identifier in the URL.

This request retrieves a single snapshot specified by the identifier in the URL.

This request retrieves a single snapshot specified by the identifier in the URL.

This request retrieves a single snapshot specified by the identifier in the URL.

This request retrieves a single snapshot specified by the identifier in the URL.

GET /snapshots/{id}
(vpc *VpcV1) GetSnapshot(getSnapshotOptions *GetSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSnapshotWithContext(ctx context.Context, getSnapshotOptions *GetSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error)
get_snapshot(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Snapshot> getSnapshot(GetSnapshotOptions getSnapshotOptions)
getSnapshot(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot.read

Auditing

Calling this method generates the following auditing events.

  • is.snapshot.snapshot.read

  • is.snapshot.snapshot-clone.read

Update a snapshot

This request updates a snapshot with the information in a provided snapshot patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot and contains only the information to be updated.

This request updates a snapshot with the information in a provided snapshot patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot and contains only the information to be updated.

This request updates a snapshot with the information in a provided snapshot patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot and contains only the information to be updated.

This request updates a snapshot with the information in a provided snapshot patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot and contains only the information to be updated.

This request updates a snapshot with the information in a provided snapshot patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot and contains only the information to be updated.

PATCH /snapshots/{id}
(vpc *VpcV1) UpdateSnapshot(updateSnapshotOptions *UpdateSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateSnapshotWithContext(ctx context.Context, updateSnapshotOptions *UpdateSnapshotOptions) (result *Snapshot, response *core.DetailedResponse, err error)
update_snapshot(
        self,
        id: str,
        snapshot_patch: 'SnapshotPatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Snapshot> updateSnapshot(UpdateSnapshotOptions updateSnapshotOptions)
updateSnapshot(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot.update

Auditing

Calling this method generates the following auditing event.

  • is.snapshot.snapshot.update

List all clones for a snapshot

This request lists all clones for a snapshot. Use a clone to quickly restore a snapshot within the clone's zone.

This request lists all clones for a snapshot. Use a clone to quickly restore a snapshot within the clone's zone.

This request lists all clones for a snapshot. Use a clone to quickly restore a snapshot within the clone's zone.

This request lists all clones for a snapshot. Use a clone to quickly restore a snapshot within the clone's zone.

This request lists all clones for a snapshot. Use a clone to quickly restore a snapshot within the clone's zone.

GET /snapshots/{id}/clones
(vpc *VpcV1) ListSnapshotClones(listSnapshotClonesOptions *ListSnapshotClonesOptions) (result *SnapshotCloneCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSnapshotClonesWithContext(ctx context.Context, listSnapshotClonesOptions *ListSnapshotClonesOptions) (result *SnapshotCloneCollection, response *core.DetailedResponse, err error)
list_snapshot_clones(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotCloneCollection> listSnapshotClones(ListSnapshotClonesOptions listSnapshotClonesOptions)
listSnapshotClones(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot.read

Auditing

Calling this method generates the following auditing event.

  • is.snapshot.snapshot-clone.read

Delete a snapshot clone

This request deletes a snapshot clone. This operation cannot be reversed, but an equivalent clone may be recreated from the snapshot.

This request deletes a snapshot clone. This operation cannot be reversed, but an equivalent clone may be recreated from the snapshot.

This request deletes a snapshot clone. This operation cannot be reversed, but an equivalent clone may be recreated from the snapshot.

This request deletes a snapshot clone. This operation cannot be reversed, but an equivalent clone may be recreated from the snapshot.

This request deletes a snapshot clone. This operation cannot be reversed, but an equivalent clone may be recreated from the snapshot.

DELETE /snapshots/{id}/clones/{zone_name}
(vpc *VpcV1) DeleteSnapshotClone(deleteSnapshotCloneOptions *DeleteSnapshotCloneOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSnapshotCloneWithContext(ctx context.Context, deleteSnapshotCloneOptions *DeleteSnapshotCloneOptions) (response *core.DetailedResponse, err error)
delete_snapshot_clone(
        self,
        id: str,
        zone_name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteSnapshotClone(DeleteSnapshotCloneOptions deleteSnapshotCloneOptions)
deleteSnapshotClone(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot-clone.delete

  • is.snapshot.snapshot.update

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.snapshot.snapshot-clone.delete

  • is.snapshot.snapshot.update

    Generated if a snapshot clone is deleted.

Retrieve a snapshot clone

This request retrieves a single clone specified by the snapshot identifier and zone name in the URL.

This request retrieves a single clone specified by the snapshot identifier and zone name in the URL.

This request retrieves a single clone specified by the snapshot identifier and zone name in the URL.

This request retrieves a single clone specified by the snapshot identifier and zone name in the URL.

This request retrieves a single clone specified by the snapshot identifier and zone name in the URL.

GET /snapshots/{id}/clones/{zone_name}
(vpc *VpcV1) GetSnapshotClone(getSnapshotCloneOptions *GetSnapshotCloneOptions) (result *SnapshotClone, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSnapshotCloneWithContext(ctx context.Context, getSnapshotCloneOptions *GetSnapshotCloneOptions) (result *SnapshotClone, response *core.DetailedResponse, err error)
get_snapshot_clone(
        self,
        id: str,
        zone_name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotClone> getSnapshotClone(GetSnapshotCloneOptions getSnapshotCloneOptions)
getSnapshotClone(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot.read

Auditing

Calling this method generates the following auditing event.

  • is.snapshot.snapshot-clone.read

Create a clone for a snapshot

This request creates a new clone for a snapshot in the specified zone. A request body is not required, and if provided, is ignored. If the snapshot already has a clone in the zone, it is returned.

This request creates a new clone for a snapshot in the specified zone. A request body is not required, and if provided, is ignored. If the snapshot already has a clone in the zone, it is returned.

This request creates a new clone for a snapshot in the specified zone. A request body is not required, and if provided, is ignored. If the snapshot already has a clone in the zone, it is returned.

This request creates a new clone for a snapshot in the specified zone. A request body is not required, and if provided, is ignored. If the snapshot already has a clone in the zone, it is returned.

This request creates a new clone for a snapshot in the specified zone. A request body is not required, and if provided, is ignored. If the snapshot already has a clone in the zone, it is returned.

PUT /snapshots/{id}/clones/{zone_name}
(vpc *VpcV1) CreateSnapshotClone(createSnapshotCloneOptions *CreateSnapshotCloneOptions) (result *SnapshotClone, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateSnapshotCloneWithContext(ctx context.Context, createSnapshotCloneOptions *CreateSnapshotCloneOptions) (result *SnapshotClone, response *core.DetailedResponse, err error)
create_snapshot_clone(
        self,
        id: str,
        zone_name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SnapshotClone> createSnapshotClone(CreateSnapshotCloneOptions createSnapshotCloneOptions)
createSnapshotClone(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.snapshot.snapshot-clone.create

  • is.snapshot.snapshot.update

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.snapshot.snapshot-clone.create

  • is.snapshot.snapshot.update

    Generated if a snapshot clone is created.

List all file share profiles

This request lists all file share profiles available in the region. A file share profile specifies the performance characteristics and pricing model for a file share.

This request lists all file share profiles available in the region. A file share profile specifies the performance characteristics and pricing model for a file share.

This request lists all file share profiles available in the region. A file share profile specifies the performance characteristics and pricing model for a file share.

This request lists all file share profiles available in the region. A file share profile specifies the performance characteristics and pricing model for a file share.

This request lists all file share profiles available in the region. A file share profile specifies the performance characteristics and pricing model for a file share.

GET /share/profiles
(vpc *VpcV1) ListShareProfiles(listShareProfilesOptions *ListShareProfilesOptions) (result *ShareProfileCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListShareProfilesWithContext(ctx context.Context, listShareProfilesOptions *ListShareProfilesOptions) (result *ShareProfileCollection, response *core.DetailedResponse, err error)
list_share_profiles(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        sort: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareProfileCollection> listShareProfiles(ListShareProfilesOptions listShareProfilesOptions)
listShareProfiles(params)

Retrieve a file share profile

This request retrieves a single file share profile specified by the name in the URL.

This request retrieves a single file share profile specified by the name in the URL.

This request retrieves a single file share profile specified by the name in the URL.

This request retrieves a single file share profile specified by the name in the URL.

This request retrieves a single file share profile specified by the name in the URL.

GET /share/profiles/{name}
(vpc *VpcV1) GetShareProfile(getShareProfileOptions *GetShareProfileOptions) (result *ShareProfile, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetShareProfileWithContext(ctx context.Context, getShareProfileOptions *GetShareProfileOptions) (result *ShareProfile, response *core.DetailedResponse, err error)
get_share_profile(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareProfile> getShareProfile(GetShareProfileOptions getShareProfileOptions)
getShareProfile(params)

List all file shares

This request lists all file shares in the region.

This request lists all file shares in the region.

This request lists all file shares in the region.

This request lists all file shares in the region.

This request lists all file shares in the region.

GET /shares
(vpc *VpcV1) ListShares(listSharesOptions *ListSharesOptions) (result *ShareCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSharesWithContext(ctx context.Context, listSharesOptions *ListSharesOptions) (result *ShareCollection, response *core.DetailedResponse, err error)
list_shares(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        name: Optional[str] = None,
        sort: Optional[str] = None,
        replication_role: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareCollection> listShares(ListSharesOptions listSharesOptions)
listShares(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.share.share.list

  • is.share.share.read

Auditing

Calling this method generates the following auditing event.

  • is.share.share.read

Create a file share

This request provisions new file shares from a share prototype object. The new file shares can be a standalone share, a replica share, or both a source and replica share.

The prototype object is structured in the same way as a retrieved share, and contains the information necessary to provision the new file shares.

This request provisions new file shares from a share prototype object. The new file shares can be a standalone share, a replica share, or both a source and replica share.

The prototype object is structured in the same way as a retrieved share, and contains the information necessary to provision the new file shares.

This request provisions new file shares from a share prototype object. The new file shares can be a standalone share, a replica share, or both a source and replica share.

The prototype object is structured in the same way as a retrieved share, and contains the information necessary to provision the new file shares.

This request provisions new file shares from a share prototype object. The new file shares can be a standalone share, a replica share, or both a source and replica share.

The prototype object is structured in the same way as a retrieved share, and contains the information necessary to provision the new file shares.

This request provisions new file shares from a share prototype object. The new file shares can be a standalone share, a replica share, or both a source and replica share.

The prototype object is structured in the same way as a retrieved share, and contains the information necessary to provision the new file shares.

POST /shares
(vpc *VpcV1) CreateShare(createShareOptions *CreateShareOptions) (result *Share, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateShareWithContext(ctx context.Context, createShareOptions *CreateShareOptions) (result *Share, response *core.DetailedResponse, err error)
create_share(
        self,
        share_prototype: 'SharePrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Share> createShare(CreateShareOptions createShareOptions)
createShare(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.share.share.create

  • is.share.share.operate

    Required when source_share is specified.

  • is.vpc.vpc.operate

  • is.virtual-network-interface.virtual-network-interface.create

    Required for share mount targets that specify a new virtual network interface

  • is.subnet.subnet.update

    Required for share mount targets that specify a new virtual network interface and a new reserved IP on a subnet

Auditing

Calling this method generates the following auditing event, depending on any listed conditions.

  • is.share.share.create

    Generated for each file share created.

Delete a file share

This request deletes a share. This operation cannot be reversed. A share cannot be deleted if it:

  • has share mount targets
  • has a lifecycle_state of updating
  • has a replication operation in progress

If the request is accepted, the share lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

This request deletes a share. This operation cannot be reversed. A share cannot be deleted if it:

  • has share mount targets
  • has a lifecycle_state of updating
  • has a replication operation in progress

If the request is accepted, the share lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

This request deletes a share. This operation cannot be reversed. A share cannot be deleted if it:

  • has share mount targets
  • has a lifecycle_state of updating
  • has a replication operation in progress

If the request is accepted, the share lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

This request deletes a share. This operation cannot be reversed. A share cannot be deleted if it:

  • has share mount targets
  • has a lifecycle_state of updating
  • has a replication operation in progress

If the request is accepted, the share lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

This request deletes a share. This operation cannot be reversed. A share cannot be deleted if it:

  • has share mount targets
  • has a lifecycle_state of updating
  • has a replication operation in progress

If the request is accepted, the share lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

DELETE /shares/{id}
(vpc *VpcV1) DeleteShare(deleteShareOptions *DeleteShareOptions) (result *Share, response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteShareWithContext(ctx context.Context, deleteShareOptions *DeleteShareOptions) (result *Share, response *core.DetailedResponse, err error)
delete_share(
        self,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Share> deleteShare(DeleteShareOptions deleteShareOptions)
deleteShare(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.delete

Auditing

Calling this method generates the following auditing event.

  • is.share.share.delete

Retrieve a file share

This request retrieves a single file share specified by the identifier in the URL.

This request retrieves a single file share specified by the identifier in the URL.

This request retrieves a single file share specified by the identifier in the URL.

This request retrieves a single file share specified by the identifier in the URL.

This request retrieves a single file share specified by the identifier in the URL.

GET /shares/{id}
(vpc *VpcV1) GetShare(getShareOptions *GetShareOptions) (result *Share, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetShareWithContext(ctx context.Context, getShareOptions *GetShareOptions) (result *Share, response *core.DetailedResponse, err error)
get_share(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Share> getShare(GetShareOptions getShareOptions)
getShare(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.read

Auditing

Calling this method generates the following auditing event.

  • is.share.share.read

Update a file share

This request updates a share with the information in a provided share patch. The share patch object is structured in the same way as a retrieved share and contains only the information to be updated.

This request updates a share with the information in a provided share patch. The share patch object is structured in the same way as a retrieved share and contains only the information to be updated.

This request updates a share with the information in a provided share patch. The share patch object is structured in the same way as a retrieved share and contains only the information to be updated.

This request updates a share with the information in a provided share patch. The share patch object is structured in the same way as a retrieved share and contains only the information to be updated.

This request updates a share with the information in a provided share patch. The share patch object is structured in the same way as a retrieved share and contains only the information to be updated.

PATCH /shares/{id}
(vpc *VpcV1) UpdateShare(updateShareOptions *UpdateShareOptions) (result *Share, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateShareWithContext(ctx context.Context, updateShareOptions *UpdateShareOptions) (result *Share, response *core.DetailedResponse, err error)
update_share(
        self,
        id: str,
        share_patch: 'SharePatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Share> updateShare(UpdateShareOptions updateShareOptions)
updateShare(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.update

Auditing

Calling this method generates the following auditing event.

  • is.share.share.update

Failover to replica file share

This request triggers a failover to the replica file share specified by the identifier in the URL. The failover cannot be started if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

If fallback_policy is specified as split, and the request is accepted but the failover operation cannot be performed, a split will be triggered.

This request triggers a failover to the replica file share specified by the identifier in the URL. The failover cannot be started if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

If fallback_policy is specified as split, and the request is accepted but the failover operation cannot be performed, a split will be triggered.

This request triggers a failover to the replica file share specified by the identifier in the URL. The failover cannot be started if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

If fallback_policy is specified as split, and the request is accepted but the failover operation cannot be performed, a split will be triggered.

This request triggers a failover to the replica file share specified by the identifier in the URL. The failover cannot be started if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

If fallback_policy is specified as split, and the request is accepted but the failover operation cannot be performed, a split will be triggered.

This request triggers a failover to the replica file share specified by the identifier in the URL. The failover cannot be started if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

If fallback_policy is specified as split, and the request is accepted but the failover operation cannot be performed, a split will be triggered.

POST /shares/{share_id}/failover
(vpc *VpcV1) FailoverShare(failoverShareOptions *FailoverShareOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) FailoverShareWithContext(ctx context.Context, failoverShareOptions *FailoverShareOptions) (response *core.DetailedResponse, err error)
failover_share(
        self,
        share_id: str,
        *,
        fallback_policy: Optional[str] = None,
        timeout: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> failoverShare(FailoverShareOptions failoverShareOptions)
failoverShare(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.operate

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.share.share.failover

  • is.share.share.split

    Generated when fallback_policy is split and the failover request was accepted but could not be performed.

List all mount targets for a file share

This request retrieves all share mount targets for a file share. A share mount target is a network endpoint at which a file share may be mounted. The file share can be mounted by clients in the same VPC and zone after creating share mount targets.

The share mount targets will be sorted by their created_at property values, with newest targets first.

This request retrieves all share mount targets for a file share. A share mount target is a network endpoint at which a file share may be mounted. The file share can be mounted by clients in the same VPC and zone after creating share mount targets.

The share mount targets will be sorted by their created_at property values, with newest targets first.

This request retrieves all share mount targets for a file share. A share mount target is a network endpoint at which a file share may be mounted. The file share can be mounted by clients in the same VPC and zone after creating share mount targets.

The share mount targets will be sorted by their created_at property values, with newest targets first.

This request retrieves all share mount targets for a file share. A share mount target is a network endpoint at which a file share may be mounted. The file share can be mounted by clients in the same VPC and zone after creating share mount targets.

The share mount targets will be sorted by their created_at property values, with newest targets first.

This request retrieves all share mount targets for a file share. A share mount target is a network endpoint at which a file share may be mounted. The file share can be mounted by clients in the same VPC and zone after creating share mount targets.

The share mount targets will be sorted by their created_at property values, with newest targets first.

GET /shares/{share_id}/mount_targets
(vpc *VpcV1) ListShareMountTargets(listShareMountTargetsOptions *ListShareMountTargetsOptions) (result *ShareMountTargetCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListShareMountTargetsWithContext(ctx context.Context, listShareMountTargetsOptions *ListShareMountTargetsOptions) (result *ShareMountTargetCollection, response *core.DetailedResponse, err error)
list_share_mount_targets(
        self,
        share_id: str,
        *,
        name: Optional[str] = None,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareMountTargetCollection> listShareMountTargets(ListShareMountTargetsOptions listShareMountTargetsOptions)
listShareMountTargets(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.read

Auditing

Calling this method generates the following auditing event.

  • is.share.mount-target.list

Create a mount target for a file share

This request creates a new share mount target from a share mount target prototype object.

The prototype object is structured in the same way as a retrieved share mount target, and contains the information necessary to provision the new file share mount target.

This request creates a new share mount target from a share mount target prototype object.

The prototype object is structured in the same way as a retrieved share mount target, and contains the information necessary to provision the new file share mount target.

This request creates a new share mount target from a share mount target prototype object.

The prototype object is structured in the same way as a retrieved share mount target, and contains the information necessary to provision the new file share mount target.

This request creates a new share mount target from a share mount target prototype object.

The prototype object is structured in the same way as a retrieved share mount target, and contains the information necessary to provision the new file share mount target.

This request creates a new share mount target from a share mount target prototype object.

The prototype object is structured in the same way as a retrieved share mount target, and contains the information necessary to provision the new file share mount target.

POST /shares/{share_id}/mount_targets
(vpc *VpcV1) CreateShareMountTarget(createShareMountTargetOptions *CreateShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateShareMountTargetWithContext(ctx context.Context, createShareMountTargetOptions *CreateShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error)
create_share_mount_target(
        self,
        share_id: str,
        share_mount_target_prototype: 'ShareMountTargetPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareMountTarget> createShareMountTarget(CreateShareMountTargetOptions createShareMountTargetOptions)
createShareMountTarget(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.share.share.update

  • is.vpc.vpc.operate

  • is.virtual-network-interface.virtual-network-interface.create

    Required for share mount targets that specify a new virtual network interface

  • is.subnet.subnet.update

    Required for share mount targets that specify a new virtual network interface and a new reserved IP on a subnet

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.share.share.update

  • is.share.mount-target.create

  • is.share.mount-target.attach

  • is.vpc.vpc.attach

    Generated for the VPC when access_control_mode is vpc.

  • is.virtual-network-interface.virtual-network-interface.create

    Generated when a new virtual network interface is created.

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated when a virtual network interface is attached to a share mount target. Also generated for each reserved IP being attached to a new virtual network interface.

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created.

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP being attached to a new virtual network interface.

  • is.subnet.subnet.update

    Generated for each reserved IP created.

  • is.security-group.security-group.attach

    Generated for each security group being attached to a new virtual network interface.

Delete a share mount target

This request deletes a share mount target. This operation cannot be reversed.

If the request is accepted, the share mount target lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

This request deletes a share mount target. This operation cannot be reversed.

If the request is accepted, the share mount target lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

This request deletes a share mount target. This operation cannot be reversed.

If the request is accepted, the share mount target lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

This request deletes a share mount target. This operation cannot be reversed.

If the request is accepted, the share mount target lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

This request deletes a share mount target. This operation cannot be reversed.

If the request is accepted, the share mount target lifecycle_state will be set to deleting. Once deletion processing completes, it will no longer be retrievable.

DELETE /shares/{share_id}/mount_targets/{id}
(vpc *VpcV1) DeleteShareMountTarget(deleteShareMountTargetOptions *DeleteShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteShareMountTargetWithContext(ctx context.Context, deleteShareMountTargetOptions *DeleteShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error)
delete_share_mount_target(
        self,
        share_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareMountTarget> deleteShareMountTarget(DeleteShareMountTargetOptions deleteShareMountTargetOptions)
deleteShareMountTarget(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.share.share.update

  • is.vpc.vpc.operate

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.share.share.update

  • is.share.mount-target.delete

  • is.share.mount-target.detach

  • is.vpc.vpc.detach

    Generated for the VPC when access_control_mode is vpc

  • is.virtual-network-interface.virtual-network-interface.delete

    Generated when the virtual network interface had auto_delete set to true

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated for the virtual network interface that was attached to the share mount target. Also generated for each reserved IP that was attached to a virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP that was attached to a virtual network interface that had auto_delete set to true

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP that had auto_delete set to true that was attached to a virtual network interface that had auto_delete set to true

  • is.subnet.subnet.update

    Generated for each reserved IP that had auto_delete set to true that was attached to a virtual network interface that had auto_delete set to true

  • is.security-group.security-group.detach

    Generated for each security group that was attached to a virtual network interface that had auto_delete set to true

Retrieve a share mount target

This request retrieves a single share mount target specified by the identifier in the URL.

This request retrieves a single share mount target specified by the identifier in the URL.

This request retrieves a single share mount target specified by the identifier in the URL.

This request retrieves a single share mount target specified by the identifier in the URL.

This request retrieves a single share mount target specified by the identifier in the URL.

GET /shares/{share_id}/mount_targets/{id}
(vpc *VpcV1) GetShareMountTarget(getShareMountTargetOptions *GetShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetShareMountTargetWithContext(ctx context.Context, getShareMountTargetOptions *GetShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error)
get_share_mount_target(
        self,
        share_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareMountTarget> getShareMountTarget(GetShareMountTargetOptions getShareMountTargetOptions)
getShareMountTarget(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.read

Auditing

Calling this method generates the following auditing event.

  • is.share.mount-target.read

Update a share mount target

This request updates a share mount target with the information provided in a share mount target patch object. The share mount target patch object is structured in the same way as a retrieved share mount target and needs to contain only the information to be updated.

This request updates a share mount target with the information provided in a share mount target patch object. The share mount target patch object is structured in the same way as a retrieved share mount target and needs to contain only the information to be updated.

This request updates a share mount target with the information provided in a share mount target patch object. The share mount target patch object is structured in the same way as a retrieved share mount target and needs to contain only the information to be updated.

This request updates a share mount target with the information provided in a share mount target patch object. The share mount target patch object is structured in the same way as a retrieved share mount target and needs to contain only the information to be updated.

This request updates a share mount target with the information provided in a share mount target patch object. The share mount target patch object is structured in the same way as a retrieved share mount target and needs to contain only the information to be updated.

PATCH /shares/{share_id}/mount_targets/{id}
(vpc *VpcV1) UpdateShareMountTarget(updateShareMountTargetOptions *UpdateShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateShareMountTargetWithContext(ctx context.Context, updateShareMountTargetOptions *UpdateShareMountTargetOptions) (result *ShareMountTarget, response *core.DetailedResponse, err error)
update_share_mount_target(
        self,
        share_id: str,
        id: str,
        share_mount_target_patch: 'ShareMountTargetPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareMountTarget> updateShareMountTarget(UpdateShareMountTargetOptions updateShareMountTargetOptions)
updateShareMountTarget(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.update

Auditing

Calling this method generates the following auditing event.

  • is.share.mount-target.update

Split the source file share from a replica share

This request removes the replication relationship between a source share and the replica share specified by the identifier in the URL. The replication relationship cannot be removed if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

This operation cannot be reversed.

This request removes the replication relationship between a source share and the replica share specified by the identifier in the URL. The replication relationship cannot be removed if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

This operation cannot be reversed.

This request removes the replication relationship between a source share and the replica share specified by the identifier in the URL. The replication relationship cannot be removed if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

This operation cannot be reversed.

This request removes the replication relationship between a source share and the replica share specified by the identifier in the URL. The replication relationship cannot be removed if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

This operation cannot be reversed.

This request removes the replication relationship between a source share and the replica share specified by the identifier in the URL. The replication relationship cannot be removed if a source share or the replica share has a lifecycle_state of updating, or has a replication operation in progress.

This operation cannot be reversed.

DELETE /shares/{share_id}/source
(vpc *VpcV1) DeleteShareSource(deleteShareSourceOptions *DeleteShareSourceOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteShareSourceWithContext(ctx context.Context, deleteShareSourceOptions *DeleteShareSourceOptions) (response *core.DetailedResponse, err error)
delete_share_source(
        self,
        share_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteShareSource(DeleteShareSourceOptions deleteShareSourceOptions)
deleteShareSource(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.operate

Auditing

Calling this method generates the following auditing event.

  • is.share.share.split

Retrieve the source file share for a replica file share

This request retrieves the source file share associated with the replica file share specified by the identifier in the URL.

This request retrieves the source file share associated with the replica file share specified by the identifier in the URL.

This request retrieves the source file share associated with the replica file share specified by the identifier in the URL.

This request retrieves the source file share associated with the replica file share specified by the identifier in the URL.

This request retrieves the source file share associated with the replica file share specified by the identifier in the URL.

GET /shares/{share_id}/source
(vpc *VpcV1) GetShareSource(getShareSourceOptions *GetShareSourceOptions) (result *ShareReference, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetShareSourceWithContext(ctx context.Context, getShareSourceOptions *GetShareSourceOptions) (result *ShareReference, response *core.DetailedResponse, err error)
get_share_source(
        self,
        share_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ShareReference> getShareSource(GetShareSourceOptions getShareSourceOptions)
getShareSource(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.share.share.read

Auditing

Calling this method generates the following auditing event.

  • is.share.share.read

List all backup policies

This request lists all backup policies in the region. Backup policies control which sources are selected for backup and include a set of backup policy plans that provide the backup schedules and deletion triggers.

This request lists all backup policies in the region. Backup policies control which sources are selected for backup and include a set of backup policy plans that provide the backup schedules and deletion triggers.

This request lists all backup policies in the region. Backup policies control which sources are selected for backup and include a set of backup policy plans that provide the backup schedules and deletion triggers.

This request lists all backup policies in the region. Backup policies control which sources are selected for backup and include a set of backup policy plans that provide the backup schedules and deletion triggers.

This request lists all backup policies in the region. Backup policies control which sources are selected for backup and include a set of backup policy plans that provide the backup schedules and deletion triggers.

GET /backup_policies
(vpc *VpcV1) ListBackupPolicies(listBackupPoliciesOptions *ListBackupPoliciesOptions) (result *BackupPolicyCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBackupPoliciesWithContext(ctx context.Context, listBackupPoliciesOptions *ListBackupPoliciesOptions) (result *BackupPolicyCollection, response *core.DetailedResponse, err error)
list_backup_policies(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        name: Optional[str] = None,
        tag: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicyCollection> listBackupPolicies(ListBackupPoliciesOptions listBackupPoliciesOptions)
listBackupPolicies(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.read

  • is.backup-policy.backup-policy.list

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-policy.read

Create a backup policy

This request creates a new backup policy from a backup policy prototype object. The prototype object is structured in the same way as a retrieved backup policy, and contains the information necessary to create the new backup policy.

This request creates a new backup policy from a backup policy prototype object. The prototype object is structured in the same way as a retrieved backup policy, and contains the information necessary to create the new backup policy.

This request creates a new backup policy from a backup policy prototype object. The prototype object is structured in the same way as a retrieved backup policy, and contains the information necessary to create the new backup policy.

This request creates a new backup policy from a backup policy prototype object. The prototype object is structured in the same way as a retrieved backup policy, and contains the information necessary to create the new backup policy.

This request creates a new backup policy from a backup policy prototype object. The prototype object is structured in the same way as a retrieved backup policy, and contains the information necessary to create the new backup policy.

POST /backup_policies
(vpc *VpcV1) CreateBackupPolicy(createBackupPolicyOptions *CreateBackupPolicyOptions) (result BackupPolicyIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateBackupPolicyWithContext(ctx context.Context, createBackupPolicyOptions *CreateBackupPolicyOptions) (result BackupPolicyIntf, response *core.DetailedResponse, err error)
create_backup_policy(
        self,
        backup_policy_prototype: 'BackupPolicyPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicy> createBackupPolicy(CreateBackupPolicyOptions createBackupPolicyOptions)
createBackupPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.create

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-policy.create

List all jobs for a backup policy

This request retrieves all jobs for a backup policy. A backup job represents the execution of a backup policy plan for a resource matching the policy's criteria.

This request retrieves all jobs for a backup policy. A backup job represents the execution of a backup policy plan for a resource matching the policy's criteria.

This request retrieves all jobs for a backup policy. A backup job represents the execution of a backup policy plan for a resource matching the policy's criteria.

This request retrieves all jobs for a backup policy. A backup job represents the execution of a backup policy plan for a resource matching the policy's criteria.

This request retrieves all jobs for a backup policy. A backup job represents the execution of a backup policy plan for a resource matching the policy's criteria.

GET /backup_policies/{backup_policy_id}/jobs
(vpc *VpcV1) ListBackupPolicyJobs(listBackupPolicyJobsOptions *ListBackupPolicyJobsOptions) (result *BackupPolicyJobCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBackupPolicyJobsWithContext(ctx context.Context, listBackupPolicyJobsOptions *ListBackupPolicyJobsOptions) (result *BackupPolicyJobCollection, response *core.DetailedResponse, err error)
list_backup_policy_jobs(
        self,
        backup_policy_id: str,
        *,
        status: Optional[str] = None,
        backup_policy_plan_id: Optional[str] = None,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        sort: Optional[str] = None,
        source_id: Optional[str] = None,
        target_snapshots_id: Optional[str] = None,
        target_snapshots_crn: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicyJobCollection> listBackupPolicyJobs(ListBackupPolicyJobsOptions listBackupPolicyJobsOptions)
listBackupPolicyJobs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.read

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-job.read

Retrieve a backup policy job

This request retrieves a single backup policy job specified by the identifier in the URL.

This request retrieves a single backup policy job specified by the identifier in the URL.

This request retrieves a single backup policy job specified by the identifier in the URL.

This request retrieves a single backup policy job specified by the identifier in the URL.

This request retrieves a single backup policy job specified by the identifier in the URL.

GET /backup_policies/{backup_policy_id}/jobs/{id}
(vpc *VpcV1) GetBackupPolicyJob(getBackupPolicyJobOptions *GetBackupPolicyJobOptions) (result *BackupPolicyJob, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBackupPolicyJobWithContext(ctx context.Context, getBackupPolicyJobOptions *GetBackupPolicyJobOptions) (result *BackupPolicyJob, response *core.DetailedResponse, err error)
get_backup_policy_job(
        self,
        backup_policy_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicyJob> getBackupPolicyJob(GetBackupPolicyJobOptions getBackupPolicyJobOptions)
getBackupPolicyJob(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.read

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-job.read

List all plans for a backup policy

This request retrieves all plans for a backup policy. Backup plans provide the backup schedule and deletion triggers.

This request retrieves all plans for a backup policy. Backup plans provide the backup schedule and deletion triggers.

This request retrieves all plans for a backup policy. Backup plans provide the backup schedule and deletion triggers.

This request retrieves all plans for a backup policy. Backup plans provide the backup schedule and deletion triggers.

This request retrieves all plans for a backup policy. Backup plans provide the backup schedule and deletion triggers.

GET /backup_policies/{backup_policy_id}/plans
(vpc *VpcV1) ListBackupPolicyPlans(listBackupPolicyPlansOptions *ListBackupPolicyPlansOptions) (result *BackupPolicyPlanCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListBackupPolicyPlansWithContext(ctx context.Context, listBackupPolicyPlansOptions *ListBackupPolicyPlansOptions) (result *BackupPolicyPlanCollection, response *core.DetailedResponse, err error)
list_backup_policy_plans(
        self,
        backup_policy_id: str,
        *,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicyPlanCollection> listBackupPolicyPlans(ListBackupPolicyPlansOptions listBackupPolicyPlansOptions)
listBackupPolicyPlans(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.read

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-plan.read

Create a plan for a backup policy

This request creates a new backup policy plan from a backup policy plan prototype object. The prototype object is structured in the same way as a retrieved backup policy plan, and contains the information necessary to create the new backup policy plan.

Backups created by this plan will use the resource group of the source being backed up.

Backups created by this plan will use the plan's name truncated to 46 characters, followed by a unique 16-character suffix.

This request creates a new backup policy plan from a backup policy plan prototype object. The prototype object is structured in the same way as a retrieved backup policy plan, and contains the information necessary to create the new backup policy plan.

Backups created by this plan will use the resource group of the source being backed up.

Backups created by this plan will use the plan's name truncated to 46 characters, followed by a unique 16-character suffix.

This request creates a new backup policy plan from a backup policy plan prototype object. The prototype object is structured in the same way as a retrieved backup policy plan, and contains the information necessary to create the new backup policy plan.

Backups created by this plan will use the resource group of the source being backed up.

Backups created by this plan will use the plan's name truncated to 46 characters, followed by a unique 16-character suffix.

This request creates a new backup policy plan from a backup policy plan prototype object. The prototype object is structured in the same way as a retrieved backup policy plan, and contains the information necessary to create the new backup policy plan.

Backups created by this plan will use the resource group of the source being backed up.

Backups created by this plan will use the plan's name truncated to 46 characters, followed by a unique 16-character suffix.

This request creates a new backup policy plan from a backup policy plan prototype object. The prototype object is structured in the same way as a retrieved backup policy plan, and contains the information necessary to create the new backup policy plan.

Backups created by this plan will use the resource group of the source being backed up.

Backups created by this plan will use the plan's name truncated to 46 characters, followed by a unique 16-character suffix.

POST /backup_policies/{backup_policy_id}/plans
(vpc *VpcV1) CreateBackupPolicyPlan(createBackupPolicyPlanOptions *CreateBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateBackupPolicyPlanWithContext(ctx context.Context, createBackupPolicyPlanOptions *CreateBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error)
create_backup_policy_plan(
        self,
        backup_policy_id: str,
        cron_spec: str,
        *,
        active: Optional[bool] = None,
        attach_user_tags: Optional[List[str]] = None,
        clone_policy: Optional['BackupPolicyPlanClonePolicyPrototype'] = None,
        copy_user_tags: Optional[bool] = None,
        deletion_trigger: Optional['BackupPolicyPlanDeletionTriggerPrototype'] = None,
        name: Optional[str] = None,
        remote_region_policies: Optional[List['BackupPolicyPlanRemoteRegionPolicyPrototype']] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicyPlan> createBackupPolicyPlan(CreateBackupPolicyPlanOptions createBackupPolicyPlanOptions)
createBackupPolicyPlan(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.update

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-plan.create

Delete a backup policy plan

This request deletes a backup policy plan. This operation cannot be reversed. Any backups that have been created by the plan will remain but will no longer be subject to the plan's deletion trigger. Any running jobs associated with the plan will run to completion before the plan is deleted.

If the request is accepted, the backup policy plan status will be set to deleting. Once deletion processing completes, the backup policy plan will no longer be retrievable.

This request deletes a backup policy plan. This operation cannot be reversed. Any backups that have been created by the plan will remain but will no longer be subject to the plan's deletion trigger. Any running jobs associated with the plan will run to completion before the plan is deleted.

If the request is accepted, the backup policy plan status will be set to deleting. Once deletion processing completes, the backup policy plan will no longer be retrievable.

This request deletes a backup policy plan. This operation cannot be reversed. Any backups that have been created by the plan will remain but will no longer be subject to the plan's deletion trigger. Any running jobs associated with the plan will run to completion before the plan is deleted.

If the request is accepted, the backup policy plan status will be set to deleting. Once deletion processing completes, the backup policy plan will no longer be retrievable.

This request deletes a backup policy plan. This operation cannot be reversed. Any backups that have been created by the plan will remain but will no longer be subject to the plan's deletion trigger. Any running jobs associated with the plan will run to completion before the plan is deleted.

If the request is accepted, the backup policy plan status will be set to deleting. Once deletion processing completes, the backup policy plan will no longer be retrievable.

This request deletes a backup policy plan. This operation cannot be reversed. Any backups that have been created by the plan will remain but will no longer be subject to the plan's deletion trigger. Any running jobs associated with the plan will run to completion before the plan is deleted.

If the request is accepted, the backup policy plan status will be set to deleting. Once deletion processing completes, the backup policy plan will no longer be retrievable.

DELETE /backup_policies/{backup_policy_id}/plans/{id}
(vpc *VpcV1) DeleteBackupPolicyPlan(deleteBackupPolicyPlanOptions *DeleteBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteBackupPolicyPlanWithContext(ctx context.Context, deleteBackupPolicyPlanOptions *DeleteBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error)
delete_backup_policy_plan(
        self,
        backup_policy_id: str,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicyPlan> deleteBackupPolicyPlan(DeleteBackupPolicyPlanOptions deleteBackupPolicyPlanOptions)
deleteBackupPolicyPlan(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.update

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-plan.delete

Retrieve a backup policy plan

This request retrieves a single backup policy plan specified by the identifier in the URL.

This request retrieves a single backup policy plan specified by the identifier in the URL.

This request retrieves a single backup policy plan specified by the identifier in the URL.

This request retrieves a single backup policy plan specified by the identifier in the URL.

This request retrieves a single backup policy plan specified by the identifier in the URL.

GET /backup_policies/{backup_policy_id}/plans/{id}
(vpc *VpcV1) GetBackupPolicyPlan(getBackupPolicyPlanOptions *GetBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBackupPolicyPlanWithContext(ctx context.Context, getBackupPolicyPlanOptions *GetBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error)
get_backup_policy_plan(
        self,
        backup_policy_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicyPlan> getBackupPolicyPlan(GetBackupPolicyPlanOptions getBackupPolicyPlanOptions)
getBackupPolicyPlan(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.read

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-plan.read

Update a backup policy plan

This request updates a backup policy plan with the information in a provided plan patch. The plan patch object is structured in the same way as a retrieved backup policy plan and can contains only the information to be updated.

This request updates a backup policy plan with the information in a provided plan patch. The plan patch object is structured in the same way as a retrieved backup policy plan and can contains only the information to be updated.

This request updates a backup policy plan with the information in a provided plan patch. The plan patch object is structured in the same way as a retrieved backup policy plan and can contains only the information to be updated.

This request updates a backup policy plan with the information in a provided plan patch. The plan patch object is structured in the same way as a retrieved backup policy plan and can contains only the information to be updated.

This request updates a backup policy plan with the information in a provided plan patch. The plan patch object is structured in the same way as a retrieved backup policy plan and can contains only the information to be updated.

PATCH /backup_policies/{backup_policy_id}/plans/{id}
(vpc *VpcV1) UpdateBackupPolicyPlan(updateBackupPolicyPlanOptions *UpdateBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateBackupPolicyPlanWithContext(ctx context.Context, updateBackupPolicyPlanOptions *UpdateBackupPolicyPlanOptions) (result *BackupPolicyPlan, response *core.DetailedResponse, err error)
update_backup_policy_plan(
        self,
        backup_policy_id: str,
        id: str,
        backup_policy_plan_patch: 'BackupPolicyPlanPatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicyPlan> updateBackupPolicyPlan(UpdateBackupPolicyPlanOptions updateBackupPolicyPlanOptions)
updateBackupPolicyPlan(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.update

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-plan.update

Delete a backup policy

This request deletes a backup policy. This operation cannot be reversed.

If the request is accepted, the backup policy status will be set to deleting. Once deletion processing completes, the backup policy will no longer be retrievable.

This request deletes a backup policy. This operation cannot be reversed.

If the request is accepted, the backup policy status will be set to deleting. Once deletion processing completes, the backup policy will no longer be retrievable.

This request deletes a backup policy. This operation cannot be reversed.

If the request is accepted, the backup policy status will be set to deleting. Once deletion processing completes, the backup policy will no longer be retrievable.

This request deletes a backup policy. This operation cannot be reversed.

If the request is accepted, the backup policy status will be set to deleting. Once deletion processing completes, the backup policy will no longer be retrievable.

This request deletes a backup policy. This operation cannot be reversed.

If the request is accepted, the backup policy status will be set to deleting. Once deletion processing completes, the backup policy will no longer be retrievable.

DELETE /backup_policies/{id}
(vpc *VpcV1) DeleteBackupPolicy(deleteBackupPolicyOptions *DeleteBackupPolicyOptions) (result BackupPolicyIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteBackupPolicyWithContext(ctx context.Context, deleteBackupPolicyOptions *DeleteBackupPolicyOptions) (result BackupPolicyIntf, response *core.DetailedResponse, err error)
delete_backup_policy(
        self,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicy> deleteBackupPolicy(DeleteBackupPolicyOptions deleteBackupPolicyOptions)
deleteBackupPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.delete

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-policy.delete

Retrieve a backup policy

This request retrieves a single backup policy specified by the identifier in the URL.

This request retrieves a single backup policy specified by the identifier in the URL.

This request retrieves a single backup policy specified by the identifier in the URL.

This request retrieves a single backup policy specified by the identifier in the URL.

This request retrieves a single backup policy specified by the identifier in the URL.

GET /backup_policies/{id}
(vpc *VpcV1) GetBackupPolicy(getBackupPolicyOptions *GetBackupPolicyOptions) (result BackupPolicyIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetBackupPolicyWithContext(ctx context.Context, getBackupPolicyOptions *GetBackupPolicyOptions) (result BackupPolicyIntf, response *core.DetailedResponse, err error)
get_backup_policy(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicy> getBackupPolicy(GetBackupPolicyOptions getBackupPolicyOptions)
getBackupPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.read

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-policy.read

Update a backup policy

This request updates a backup policy with the information in a provided backup policy patch. The backup policy patch object is structured in the same way as a retrieved backup policy and contains only the information to be updated.

This request updates a backup policy with the information in a provided backup policy patch. The backup policy patch object is structured in the same way as a retrieved backup policy and contains only the information to be updated.

This request updates a backup policy with the information in a provided backup policy patch. The backup policy patch object is structured in the same way as a retrieved backup policy and contains only the information to be updated.

This request updates a backup policy with the information in a provided backup policy patch. The backup policy patch object is structured in the same way as a retrieved backup policy and contains only the information to be updated.

This request updates a backup policy with the information in a provided backup policy patch. The backup policy patch object is structured in the same way as a retrieved backup policy and contains only the information to be updated.

PATCH /backup_policies/{id}
(vpc *VpcV1) UpdateBackupPolicy(updateBackupPolicyOptions *UpdateBackupPolicyOptions) (result BackupPolicyIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateBackupPolicyWithContext(ctx context.Context, updateBackupPolicyOptions *UpdateBackupPolicyOptions) (result BackupPolicyIntf, response *core.DetailedResponse, err error)
update_backup_policy(
        self,
        id: str,
        backup_policy_patch: 'BackupPolicyPatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<BackupPolicy> updateBackupPolicy(UpdateBackupPolicyOptions updateBackupPolicyOptions)
updateBackupPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.backup-policy.backup-policy.update

Auditing

Calling this method generates the following auditing event.

  • is.backup-policy.backup-policy.update

List all regions

This request lists all regions. Each region is a separate geographic area that contains multiple isolated zones. Resources can be provisioned into one or more zones in a region. Each zone is isolated, but connected to other zones in the same region with low-latency and high-bandwidth links. Regions represent the top-level of fault isolation available. Resources deployed within a single region also benefit from the low latency afforded by geographic proximity.

This request lists all regions. Each region is a separate geographic area that contains multiple isolated zones. Resources can be provisioned into one or more zones in a region. Each zone is isolated, but connected to other zones in the same region with low-latency and high-bandwidth links. Regions represent the top-level of fault isolation available. Resources deployed within a single region also benefit from the low latency afforded by geographic proximity.

This request lists all regions. Each region is a separate geographic area that contains multiple isolated zones. Resources can be provisioned into one or more zones in a region. Each zone is isolated, but connected to other zones in the same region with low-latency and high-bandwidth links. Regions represent the top-level of fault isolation available. Resources deployed within a single region also benefit from the low latency afforded by geographic proximity.

This request lists all regions. Each region is a separate geographic area that contains multiple isolated zones. Resources can be provisioned into one or more zones in a region. Each zone is isolated, but connected to other zones in the same region with low-latency and high-bandwidth links. Regions represent the top-level of fault isolation available. Resources deployed within a single region also benefit from the low latency afforded by geographic proximity.

This request lists all regions. Each region is a separate geographic area that contains multiple isolated zones. Resources can be provisioned into one or more zones in a region. Each zone is isolated, but connected to other zones in the same region with low-latency and high-bandwidth links. Regions represent the top-level of fault isolation available. Resources deployed within a single region also benefit from the low latency afforded by geographic proximity.

GET /regions
(vpc *VpcV1) ListRegions(listRegionsOptions *ListRegionsOptions) (result *RegionCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListRegionsWithContext(ctx context.Context, listRegionsOptions *ListRegionsOptions) (result *RegionCollection, response *core.DetailedResponse, err error)
list_regions(
        self,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<RegionCollection> listRegions(ListRegionsOptions listRegionsOptions)
listRegions(params)

Retrieve a region

This request retrieves a single region specified by the name in the URL.

This request retrieves a single region specified by the name in the URL.

This request retrieves a single region specified by the name in the URL.

This request retrieves a single region specified by the name in the URL.

This request retrieves a single region specified by the name in the URL.

GET /regions/{name}
(vpc *VpcV1) GetRegion(getRegionOptions *GetRegionOptions) (result *Region, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetRegionWithContext(ctx context.Context, getRegionOptions *GetRegionOptions) (result *Region, response *core.DetailedResponse, err error)
get_region(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Region> getRegion(GetRegionOptions getRegionOptions)
getRegion(params)

List all zones in a region

This request lists all zones in a region. Zones represent logically-isolated data centers with high-bandwidth and low-latency interconnects to other zones in the same region. Faults in a zone do not affect other zones.

This request lists all zones in a region. Zones represent logically-isolated data centers with high-bandwidth and low-latency interconnects to other zones in the same region. Faults in a zone do not affect other zones.

This request lists all zones in a region. Zones represent logically-isolated data centers with high-bandwidth and low-latency interconnects to other zones in the same region. Faults in a zone do not affect other zones.

This request lists all zones in a region. Zones represent logically-isolated data centers with high-bandwidth and low-latency interconnects to other zones in the same region. Faults in a zone do not affect other zones.

This request lists all zones in a region. Zones represent logically-isolated data centers with high-bandwidth and low-latency interconnects to other zones in the same region. Faults in a zone do not affect other zones.

GET /regions/{region_name}/zones
(vpc *VpcV1) ListRegionZones(listRegionZonesOptions *ListRegionZonesOptions) (result *ZoneCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListRegionZonesWithContext(ctx context.Context, listRegionZonesOptions *ListRegionZonesOptions) (result *ZoneCollection, response *core.DetailedResponse, err error)
list_region_zones(
        self,
        region_name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ZoneCollection> listRegionZones(ListRegionZonesOptions listRegionZonesOptions)
listRegionZones(params)

Retrieve a zone

This request retrieves a single zone specified by the region and zone names in the URL.

This request retrieves a single zone specified by the region and zone names in the URL.

This request retrieves a single zone specified by the region and zone names in the URL.

This request retrieves a single zone specified by the region and zone names in the URL.

This request retrieves a single zone specified by the region and zone names in the URL.

GET /regions/{region_name}/zones/{name}
(vpc *VpcV1) GetRegionZone(getRegionZoneOptions *GetRegionZoneOptions) (result *Zone, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetRegionZoneWithContext(ctx context.Context, getRegionZoneOptions *GetRegionZoneOptions) (result *Zone, response *core.DetailedResponse, err error)
get_region_zone(
        self,
        region_name: str,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Zone> getRegionZone(GetRegionZoneOptions getRegionZoneOptions)
getRegionZone(params)

List all virtual network interfaces

This request lists all virtual network interfaces in the region. A virtual network interface is a logical abstraction of a virtual network interface in a subnet, and may be attached to a target resource.

The virtual network interfaces will be sorted by their created_at property values, with newest virtual network interfaces first. Virtual network interfaces with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all virtual network interfaces in the region. A virtual network interface is a logical abstraction of a virtual network interface in a subnet, and may be attached to a target resource.

The virtual network interfaces will be sorted by their created_at property values, with newest virtual network interfaces first. Virtual network interfaces with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all virtual network interfaces in the region. A virtual network interface is a logical abstraction of a virtual network interface in a subnet, and may be attached to a target resource.

The virtual network interfaces will be sorted by their created_at property values, with newest virtual network interfaces first. Virtual network interfaces with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all virtual network interfaces in the region. A virtual network interface is a logical abstraction of a virtual network interface in a subnet, and may be attached to a target resource.

The virtual network interfaces will be sorted by their created_at property values, with newest virtual network interfaces first. Virtual network interfaces with identical created_at property values will in turn be sorted by ascending name property values.

This request lists all virtual network interfaces in the region. A virtual network interface is a logical abstraction of a virtual network interface in a subnet, and may be attached to a target resource.

The virtual network interfaces will be sorted by their created_at property values, with newest virtual network interfaces first. Virtual network interfaces with identical created_at property values will in turn be sorted by ascending name property values.

GET /virtual_network_interfaces
(vpc *VpcV1) ListVirtualNetworkInterfaces(listVirtualNetworkInterfacesOptions *ListVirtualNetworkInterfacesOptions) (result *VirtualNetworkInterfaceCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVirtualNetworkInterfacesWithContext(ctx context.Context, listVirtualNetworkInterfacesOptions *ListVirtualNetworkInterfacesOptions) (result *VirtualNetworkInterfaceCollection, response *core.DetailedResponse, err error)
list_virtual_network_interfaces(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VirtualNetworkInterfaceCollection> listVirtualNetworkInterfaces(ListVirtualNetworkInterfacesOptions listVirtualNetworkInterfacesOptions)
listVirtualNetworkInterfaces(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.list

  • is.virtual-network-interface.virtual-network-interface.read

Auditing

Calling this method generates the following auditing event.

  • is.virtual-network-interface.virtual-network-interface.list

Create a virtual network interface

This request creates a new virtual network interface from a virtual network interface prototype object. The prototype object is structured in the same way as a retrieved virtual network interface, and contains the information necessary to create the new virtual network interface.

This request creates a new virtual network interface from a virtual network interface prototype object. The prototype object is structured in the same way as a retrieved virtual network interface, and contains the information necessary to create the new virtual network interface.

This request creates a new virtual network interface from a virtual network interface prototype object. The prototype object is structured in the same way as a retrieved virtual network interface, and contains the information necessary to create the new virtual network interface.

This request creates a new virtual network interface from a virtual network interface prototype object. The prototype object is structured in the same way as a retrieved virtual network interface, and contains the information necessary to create the new virtual network interface.

This request creates a new virtual network interface from a virtual network interface prototype object. The prototype object is structured in the same way as a retrieved virtual network interface, and contains the information necessary to create the new virtual network interface.

POST /virtual_network_interfaces
(vpc *VpcV1) CreateVirtualNetworkInterface(createVirtualNetworkInterfaceOptions *CreateVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVirtualNetworkInterfaceWithContext(ctx context.Context, createVirtualNetworkInterfaceOptions *CreateVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error)
create_virtual_network_interface(
        self,
        *,
        allow_ip_spoofing: Optional[bool] = None,
        auto_delete: Optional[bool] = None,
        enable_infrastructure_nat: Optional[bool] = None,
        ips: Optional[List['VirtualNetworkInterfaceIPPrototype']] = None,
        name: Optional[str] = None,
        primary_ip: Optional['VirtualNetworkInterfacePrimaryIPPrototype'] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        security_groups: Optional[List['SecurityGroupIdentity']] = None,
        subnet: Optional['SubnetIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VirtualNetworkInterface> createVirtualNetworkInterface(CreateVirtualNetworkInterfaceOptions createVirtualNetworkInterfaceOptions)
createVirtualNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.create

  • is.virtual-network-interface.virtual-network-interface.manage-ip-spoofing

    Required when allow_ip_spoofing is true

  • is.virtual-network-interface.virtual-network-interface.manage-infrastructure-nat

    Required when enable_infrastructure_nat is false

  • is.security-group.security-group.operate

  • is.subnet.subnet.operate

    Required for virtual network interfaces that specify an existing reserved IP on a subnet

  • is.subnet.subnet.update

    Required for virtual network interfaces that specify a new reserved IP on a subnet

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.virtual-network-interface.virtual-network-interface.create

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated for each reserved IP being attached to the virtual network interface

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created

  • is.subnet.subnet.update

    Generated for each reserved IP created

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP being attached to the virtual network interface

  • is.security-group.security-group.attach

    Generated for each security group being attached to the virtual network interface

Delete a virtual network interface

This request deletes a virtual network interface. This operation cannot be reversed. For this request to succeed, the virtual network interface must not be required by another resource, such as the primary network attachment for an instance.

This request deletes a virtual network interface. This operation cannot be reversed. For this request to succeed, the virtual network interface must not be required by another resource, such as the primary network attachment for an instance.

This request deletes a virtual network interface. This operation cannot be reversed. For this request to succeed, the virtual network interface must not be required by another resource, such as the primary network attachment for an instance.

This request deletes a virtual network interface. This operation cannot be reversed. For this request to succeed, the virtual network interface must not be required by another resource, such as the primary network attachment for an instance.

This request deletes a virtual network interface. This operation cannot be reversed. For this request to succeed, the virtual network interface must not be required by another resource, such as the primary network attachment for an instance.

DELETE /virtual_network_interfaces/{id}
(vpc *VpcV1) DeleteVirtualNetworkInterfaces(deleteVirtualNetworkInterfacesOptions *DeleteVirtualNetworkInterfacesOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVirtualNetworkInterfacesWithContext(ctx context.Context, deleteVirtualNetworkInterfacesOptions *DeleteVirtualNetworkInterfacesOptions) (response *core.DetailedResponse, err error)
delete_virtual_network_interfaces(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVirtualNetworkInterfaces(DeleteVirtualNetworkInterfacesOptions deleteVirtualNetworkInterfacesOptions)
deleteVirtualNetworkInterfaces(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.virtual-network-interface.virtual-network-interface.delete

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated for resource being detached from the virtual network interface:

    • reserved IPs
    • security groups

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP that had auto_delete set to true

  • is.subnet.subnet.update

    Generated for each reserved IP that had auto_delete set to true

  • is.floating-ip.floating-ip.detach

    Generated for each floating IP being detached from the virtual network interface

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP being detached from the virtual network interface

  • is.security-group.security-group.detach

    Generated for each security group being detached from the virtual network interface

  • is.flow-log-collector.flow-log-collector.delete

    Generated when a flow log collector that had auto_delete set to true was attached to the virtual network interface

  • is.flow-log-collector.flow-log-collector.detach

    Generated if a flow log collector is detached from the virtual network interface

Retrieve a virtual network interface

This request retrieves a single virtual network interface specified by the identifier in the URL.

This request retrieves a single virtual network interface specified by the identifier in the URL.

This request retrieves a single virtual network interface specified by the identifier in the URL.

This request retrieves a single virtual network interface specified by the identifier in the URL.

This request retrieves a single virtual network interface specified by the identifier in the URL.

GET /virtual_network_interfaces/{id}
(vpc *VpcV1) GetVirtualNetworkInterface(getVirtualNetworkInterfaceOptions *GetVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVirtualNetworkInterfaceWithContext(ctx context.Context, getVirtualNetworkInterfaceOptions *GetVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error)
get_virtual_network_interface(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VirtualNetworkInterface> getVirtualNetworkInterface(GetVirtualNetworkInterfaceOptions getVirtualNetworkInterfaceOptions)
getVirtualNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.read

Auditing

Calling this method generates the following auditing event.

  • is.virtual-network-interface.virtual-network-interface.read

Update a virtual network interface

This request updates a virtual network interface with the information in a provided virtual network interface patch. The virtual network interface patch object is structured in the same way as a retrieved virtual network interface and contains only the information to be updated.

This request updates a virtual network interface with the information in a provided virtual network interface patch. The virtual network interface patch object is structured in the same way as a retrieved virtual network interface and contains only the information to be updated.

This request updates a virtual network interface with the information in a provided virtual network interface patch. The virtual network interface patch object is structured in the same way as a retrieved virtual network interface and contains only the information to be updated.

This request updates a virtual network interface with the information in a provided virtual network interface patch. The virtual network interface patch object is structured in the same way as a retrieved virtual network interface and contains only the information to be updated.

This request updates a virtual network interface with the information in a provided virtual network interface patch. The virtual network interface patch object is structured in the same way as a retrieved virtual network interface and contains only the information to be updated.

PATCH /virtual_network_interfaces/{id}
(vpc *VpcV1) UpdateVirtualNetworkInterface(updateVirtualNetworkInterfaceOptions *UpdateVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVirtualNetworkInterfaceWithContext(ctx context.Context, updateVirtualNetworkInterfaceOptions *UpdateVirtualNetworkInterfaceOptions) (result *VirtualNetworkInterface, response *core.DetailedResponse, err error)
update_virtual_network_interface(
        self,
        id: str,
        virtual_network_interface_patch: 'VirtualNetworkInterfacePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VirtualNetworkInterface> updateVirtualNetworkInterface(UpdateVirtualNetworkInterfaceOptions updateVirtualNetworkInterfaceOptions)
updateVirtualNetworkInterface(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.update

  • is.virtual-network-interface.virtual-network-interface.manage-ip-spoofing

    Required when updating allow_ip_spoofing to or from true

  • is.virtual-network-interface.virtual-network-interface.manage-infrastructure-nat

    Required when updating enable_infrastructure_nat to or from false

Auditing

Calling this method generates the following auditing event.

  • is.virtual-network-interface.virtual-network-interface.update

List all floating IPs associated with a virtual network interface

This request lists all floating IPs associated with a virtual network interface.

This request lists all floating IPs associated with a virtual network interface.

This request lists all floating IPs associated with a virtual network interface.

This request lists all floating IPs associated with a virtual network interface.

This request lists all floating IPs associated with a virtual network interface.

GET /virtual_network_interfaces/{virtual_network_interface_id}/floating_ips
(vpc *VpcV1) ListNetworkInterfaceFloatingIps(listNetworkInterfaceFloatingIpsOptions *ListNetworkInterfaceFloatingIpsOptions) (result *FloatingIPCollectionVirtualNetworkInterfaceContext, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListNetworkInterfaceFloatingIpsWithContext(ctx context.Context, listNetworkInterfaceFloatingIpsOptions *ListNetworkInterfaceFloatingIpsOptions) (result *FloatingIPCollectionVirtualNetworkInterfaceContext, response *core.DetailedResponse, err error)
list_network_interface_floating_ips(
        self,
        virtual_network_interface_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        sort: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIPCollectionVirtualNetworkInterfaceContext> listNetworkInterfaceFloatingIps(ListNetworkInterfaceFloatingIpsOptions listNetworkInterfaceFloatingIpsOptions)
listNetworkInterfaceFloatingIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.read

Auditing

Calling this method generates the following auditing event.

  • is.virtual-network-interface.virtual-network-interface.read

Disassociate a floating IP from a virtual network interface

This request disassociates the specified floating IP from the specified virtual network interface

This request disassociates the specified floating IP from the specified virtual network interface.

This request disassociates the specified floating IP from the specified virtual network interface.

This request disassociates the specified floating IP from the specified virtual network interface.

This request disassociates the specified floating IP from the specified virtual network interface.

DELETE /virtual_network_interfaces/{virtual_network_interface_id}/floating_ips/{id}
(vpc *VpcV1) RemoveNetworkInterfaceFloatingIP(removeNetworkInterfaceFloatingIPOptions *RemoveNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) RemoveNetworkInterfaceFloatingIPWithContext(ctx context.Context, removeNetworkInterfaceFloatingIPOptions *RemoveNetworkInterfaceFloatingIPOptions) (response *core.DetailedResponse, err error)
remove_network_interface_floating_ip(
        self,
        virtual_network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> removeNetworkInterfaceFloatingIp(RemoveNetworkInterfaceFloatingIpOptions removeNetworkInterfaceFloatingIpOptions)
removeNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.operate

  • is.floating-ip.floating-ip.operate

Auditing

Calling this method generates the following auditing events.

  • is.virtual-network-interface.virtual-network-interface.detach

  • is.floating-ip.floating-ip.detach

Retrieve associated floating IP

This request retrieves a specified floating IP if it is associated with the virtual network interface specified in the URL

This request retrieves a specified floating IP if it is associated with the virtual network interface specified in the URL.

This request retrieves a specified floating IP if it is associated with the virtual network interface specified in the URL.

This request retrieves a specified floating IP if it is associated with the virtual network interface specified in the URL.

This request retrieves a specified floating IP if it is associated with the virtual network interface specified in the URL.

GET /virtual_network_interfaces/{virtual_network_interface_id}/floating_ips/{id}
(vpc *VpcV1) GetNetworkInterfaceFloatingIP(getNetworkInterfaceFloatingIPOptions *GetNetworkInterfaceFloatingIPOptions) (result *FloatingIPReference, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetNetworkInterfaceFloatingIPWithContext(ctx context.Context, getNetworkInterfaceFloatingIPOptions *GetNetworkInterfaceFloatingIPOptions) (result *FloatingIPReference, response *core.DetailedResponse, err error)
get_network_interface_floating_ip(
        self,
        virtual_network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIPReference> getNetworkInterfaceFloatingIp(GetNetworkInterfaceFloatingIpOptions getNetworkInterfaceFloatingIpOptions)
getNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.read

Auditing

Calling this method generates the following auditing event.

  • is.virtual-network-interface.virtual-network-interface.read

Add an association between a floating IP and a virtual network interface

This request adds an association between the specified floating IP and the specified virtual network interface.

If the virtual network interface has enable_infrastructure_nat set to true, no more than one floating IP can be associated, and network address translation is performed between the floating IP address and the virtual network interface's primary_ip address.

If the virtual network interface has enable_infrastructure_nat set to false, packets are passed unchanged to/from the virtual network interface.

The floating IP must:

  • be in the same zone as the virtual network interface
  • not currently be associated with another resource

The virtual network interface's target must not currently be a file share mount target.

A request body is not required, and if provided, is ignored.

This request adds an association between the specified floating IP and the specified virtual network interface.

If the virtual network interface has enable_infrastructure_nat set to true, no more than one floating IP can be associated, and network address translation is performed between the floating IP address and the virtual network interface's primary_ip address.

If the virtual network interface has enable_infrastructure_nat set to false, packets are passed unchanged to/from the virtual network interface.

The floating IP must:

  • be in the same zone as the virtual network interface
  • not currently be associated with another resource

The virtual network interface's target must not currently be a file share mount target.

A request body is not required, and if provided, is ignored.

This request adds an association between the specified floating IP and the specified virtual network interface.

If the virtual network interface has enable_infrastructure_nat set to true, no more than one floating IP can be associated, and network address translation is performed between the floating IP address and the virtual network interface's primary_ip address.

If the virtual network interface has enable_infrastructure_nat set to false, packets are passed unchanged to/from the virtual network interface.

The floating IP must:

  • be in the same zone as the virtual network interface
  • not currently be associated with another resource

The virtual network interface's target must not currently be a file share mount target.

A request body is not required, and if provided, is ignored.

This request adds an association between the specified floating IP and the specified virtual network interface.

If the virtual network interface has enable_infrastructure_nat set to true, no more than one floating IP can be associated, and network address translation is performed between the floating IP address and the virtual network interface's primary_ip address.

If the virtual network interface has enable_infrastructure_nat set to false, packets are passed unchanged to/from the virtual network interface.

The floating IP must:

  • be in the same zone as the virtual network interface
  • not currently be associated with another resource

The virtual network interface's target must not currently be a file share mount target.

A request body is not required, and if provided, is ignored.

This request adds an association between the specified floating IP and the specified virtual network interface.

If the virtual network interface has enable_infrastructure_nat set to true, no more than one floating IP can be associated, and network address translation is performed between the floating IP address and the virtual network interface's primary_ip address.

If the virtual network interface has enable_infrastructure_nat set to false, packets are passed unchanged to/from the virtual network interface.

The floating IP must:

  • be in the same zone as the virtual network interface
  • not currently be associated with another resource

The virtual network interface's target must not currently be a file share mount target.

A request body is not required, and if provided, is ignored.

PUT /virtual_network_interfaces/{virtual_network_interface_id}/floating_ips/{id}
(vpc *VpcV1) AddNetworkInterfaceFloatingIP(addNetworkInterfaceFloatingIPOptions *AddNetworkInterfaceFloatingIPOptions) (result *FloatingIPReference, response *core.DetailedResponse, err error)
(vpc *VpcV1) AddNetworkInterfaceFloatingIPWithContext(ctx context.Context, addNetworkInterfaceFloatingIPOptions *AddNetworkInterfaceFloatingIPOptions) (result *FloatingIPReference, response *core.DetailedResponse, err error)
add_network_interface_floating_ip(
        self,
        virtual_network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIPReference> addNetworkInterfaceFloatingIp(AddNetworkInterfaceFloatingIpOptions addNetworkInterfaceFloatingIpOptions)
addNetworkInterfaceFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.operate

  • is.floating-ip.floating-ip.operate

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.virtual-network-interface.virtual-network-interface.attach

  • is.floating-ip.floating-ip.attach

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated when a floating IP that was attached to a virtual network interface is replaced

  • is.instance.network-interface.detach

    Generated when a floating IP that was attached to an instance network interface is replaced

  • is.bare-metal-server.network-interface.detach

    Generated when a floating IP that was attached to a bare metal server network interface is replaced

  • is.floating-ip.floating-ip.detach

    Generated when a floating IP that was attached to a resource is replaced

List all reserved IPs bound to a virtual network interface

This request lists all reserved IPs bound to a virtual network interface.

This request lists all reserved IPs bound to a virtual network interface.

This request lists all reserved IPs bound to a virtual network interface.

This request lists all reserved IPs bound to a virtual network interface.

This request lists all reserved IPs bound to a virtual network interface.

GET /virtual_network_interfaces/{virtual_network_interface_id}/ips
(vpc *VpcV1) ListVirtualNetworkInterfaceIps(listVirtualNetworkInterfaceIpsOptions *ListVirtualNetworkInterfaceIpsOptions) (result *ReservedIPCollectionVirtualNetworkInterfaceContext, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVirtualNetworkInterfaceIpsWithContext(ctx context.Context, listVirtualNetworkInterfaceIpsOptions *ListVirtualNetworkInterfaceIpsOptions) (result *ReservedIPCollectionVirtualNetworkInterfaceContext, response *core.DetailedResponse, err error)
list_virtual_network_interface_ips(
        self,
        virtual_network_interface_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        sort: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIPCollectionVirtualNetworkInterfaceContext> listVirtualNetworkInterfaceIps(ListVirtualNetworkInterfaceIpsOptions listVirtualNetworkInterfaceIpsOptions)
listVirtualNetworkInterfaceIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.read

Auditing

Calling this method generates the following auditing event, depending on any listed conditions.

  • is.virtual-network-interface.virtual-network-interface.read

    Generated for each reserved IP in the list.

Unbind a reserved IP from a virtual network interface

This request unbinds the specified reserved IP from the specified virtual network interface. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

The reserved IP for the primary_ip cannot be unbound.

This request unbinds the specified reserved IP from the specified virtual network interface. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

The reserved IP for the primary_ip cannot be unbound.

This request unbinds the specified reserved IP from the specified virtual network interface. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

The reserved IP for the primary_ip cannot be unbound.

This request unbinds the specified reserved IP from the specified virtual network interface. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

The reserved IP for the primary_ip cannot be unbound.

This request unbinds the specified reserved IP from the specified virtual network interface. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

The reserved IP for the primary_ip cannot be unbound.

DELETE /virtual_network_interfaces/{virtual_network_interface_id}/ips/{id}
(vpc *VpcV1) RemoveVirtualNetworkInterfaceIP(removeVirtualNetworkInterfaceIPOptions *RemoveVirtualNetworkInterfaceIPOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) RemoveVirtualNetworkInterfaceIPWithContext(ctx context.Context, removeVirtualNetworkInterfaceIPOptions *RemoveVirtualNetworkInterfaceIPOptions) (response *core.DetailedResponse, err error)
remove_virtual_network_interface_ip(
        self,
        virtual_network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> removeVirtualNetworkInterfaceIp(RemoveVirtualNetworkInterfaceIpOptions removeVirtualNetworkInterfaceIpOptions)
removeVirtualNetworkInterfaceIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.operate

  • is.subnet.subnet.operate

    Required for the subnet attached to the virtual network interface

Auditing

Calling this method generates the following auditing events.

  • is.virtual-network-interface.virtual-network-interface.detach

  • is.subnet.reserved-ip.detach

Retrieve bound reserved IP

This request retrieves the specified reserved IP address if it is bound to the virtual network interface specified in the URL.

This request retrieves the specified reserved IP address if it is bound to the virtual network interface specified in the URL.

This request retrieves the specified reserved IP address if it is bound to the virtual network interface specified in the URL.

This request retrieves the specified reserved IP address if it is bound to the virtual network interface specified in the URL.

This request retrieves the specified reserved IP address if it is bound to the virtual network interface specified in the URL.

GET /virtual_network_interfaces/{virtual_network_interface_id}/ips/{id}
(vpc *VpcV1) GetVirtualNetworkInterfaceIP(getVirtualNetworkInterfaceIPOptions *GetVirtualNetworkInterfaceIPOptions) (result *ReservedIPReference, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVirtualNetworkInterfaceIPWithContext(ctx context.Context, getVirtualNetworkInterfaceIPOptions *GetVirtualNetworkInterfaceIPOptions) (result *ReservedIPReference, response *core.DetailedResponse, err error)
get_virtual_network_interface_ip(
        self,
        virtual_network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIPReference> getVirtualNetworkInterfaceIp(GetVirtualNetworkInterfaceIpOptions getVirtualNetworkInterfaceIpOptions)
getVirtualNetworkInterfaceIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.read

Auditing

Calling this method generates the following auditing event.

  • is.virtual-network-interface.virtual-network-interface.read

Bind a reserved IP to a virtual network interface

This request binds the specified reserved IP to the specified virtual network interface.

The reserved IP must currently be unbound and in the primary IP's subnet. The virtual network interface's target must not currently be a file share mount target.

This request binds the specified reserved IP to the specified virtual network interface.

The reserved IP must currently be unbound and in the primary IP's subnet. The virtual network interface's target must not currently be a file share mount target.

This request binds the specified reserved IP to the specified virtual network interface.

The reserved IP must currently be unbound and in the primary IP's subnet. The virtual network interface's target must not currently be a file share mount target.

This request binds the specified reserved IP to the specified virtual network interface.

The reserved IP must currently be unbound and in the primary IP's subnet. The virtual network interface's target must not currently be a file share mount target.

This request binds the specified reserved IP to the specified virtual network interface.

The reserved IP must currently be unbound and in the primary IP's subnet. The virtual network interface's target must not currently be a file share mount target.

PUT /virtual_network_interfaces/{virtual_network_interface_id}/ips/{id}
(vpc *VpcV1) AddVirtualNetworkInterfaceIP(addVirtualNetworkInterfaceIPOptions *AddVirtualNetworkInterfaceIPOptions) (result *ReservedIPReference, response *core.DetailedResponse, err error)
(vpc *VpcV1) AddVirtualNetworkInterfaceIPWithContext(ctx context.Context, addVirtualNetworkInterfaceIPOptions *AddVirtualNetworkInterfaceIPOptions) (result *ReservedIPReference, response *core.DetailedResponse, err error)
add_virtual_network_interface_ip(
        self,
        virtual_network_interface_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIPReference> addVirtualNetworkInterfaceIp(AddVirtualNetworkInterfaceIpOptions addVirtualNetworkInterfaceIpOptions)
addVirtualNetworkInterfaceIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.virtual-network-interface.virtual-network-interface.operate

  • is.subnet.subnet.operate

    Required for the subnet attached to the virtual network interface

Auditing

Calling this method generates the following auditing events.

  • is.virtual-network-interface.virtual-network-interface.attach

  • is.subnet.reserved-ip.attach

List all public gateways

This request lists all public gateways in the region. A public gateway is a virtual network device associated with a VPC, which allows access to the Internet. A public gateway resides in a zone and can be connected to subnets in the same zone only.

This request lists all public gateways in the region. A public gateway is a virtual network device associated with a VPC, which allows access to the Internet. A public gateway resides in a zone and can be connected to subnets in the same zone only.

This request lists all public gateways in the region. A public gateway is a virtual network device associated with a VPC, which allows access to the Internet. A public gateway resides in a zone and can be connected to subnets in the same zone only.

This request lists all public gateways in the region. A public gateway is a virtual network device associated with a VPC, which allows access to the Internet. A public gateway resides in a zone and can be connected to subnets in the same zone only.

This request lists all public gateways in the region. A public gateway is a virtual network device associated with a VPC, which allows access to the Internet. A public gateway resides in a zone and can be connected to subnets in the same zone only.

GET /public_gateways
(vpc *VpcV1) ListPublicGateways(listPublicGatewaysOptions *ListPublicGatewaysOptions) (result *PublicGatewayCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListPublicGatewaysWithContext(ctx context.Context, listPublicGatewaysOptions *ListPublicGatewaysOptions) (result *PublicGatewayCollection, response *core.DetailedResponse, err error)
list_public_gateways(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PublicGatewayCollection> listPublicGateways(ListPublicGatewaysOptions listPublicGatewaysOptions)
listPublicGateways(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.public-gateway.public-gateway.list

  • is.public-gateway.public-gateway.read

Auditing

Calling this method generates the following auditing event.

  • is.public-gateway.public-gateway.read

Create a public gateway

This request creates a new public gateway from a public gateway prototype object. For this to succeed, the VPC must not already have a public gateway in the specified zone.

If a floating IP is provided, it must be unbound. If a floating IP is not provided, one will be created and bound to the public gateway. Once a public gateway has been created, its floating IP cannot be unbound. A public gateway must be explicitly attached to each subnet it will provide connectivity for.

This request creates a new public gateway from a public gateway prototype object. For this to succeed, the VPC must not already have a public gateway in the specified zone.

If a floating IP is provided, it must be unbound. If a floating IP is not provided, one will be created and bound to the public gateway. Once a public gateway has been created, its floating IP cannot be unbound. A public gateway must be explicitly attached to each subnet it will provide connectivity for.

This request creates a new public gateway from a public gateway prototype object. For this to succeed, the VPC must not already have a public gateway in the specified zone.

If a floating IP is provided, it must be unbound. If a floating IP is not provided, one will be created and bound to the public gateway. Once a public gateway has been created, its floating IP cannot be unbound. A public gateway must be explicitly attached to each subnet it will provide connectivity for.

This request creates a new public gateway from a public gateway prototype object. For this to succeed, the VPC must not already have a public gateway in the specified zone.

If a floating IP is provided, it must be unbound. If a floating IP is not provided, one will be created and bound to the public gateway. Once a public gateway has been created, its floating IP cannot be unbound. A public gateway must be explicitly attached to each subnet it will provide connectivity for.

This request creates a new public gateway from a public gateway prototype object. For this to succeed, the VPC must not already have a public gateway in the specified zone.

If a floating IP is provided, it must be unbound. If a floating IP is not provided, one will be created and bound to the public gateway. Once a public gateway has been created, its floating IP cannot be unbound. A public gateway must be explicitly attached to each subnet it will provide connectivity for.

POST /public_gateways
(vpc *VpcV1) CreatePublicGateway(createPublicGatewayOptions *CreatePublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreatePublicGatewayWithContext(ctx context.Context, createPublicGatewayOptions *CreatePublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
create_public_gateway(
        self,
        vpc: 'VPCIdentity',
        zone: 'ZoneIdentity',
        *,
        floating_ip: Optional['PublicGatewayFloatingIPPrototype'] = None,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PublicGateway> createPublicGateway(CreatePublicGatewayOptions createPublicGatewayOptions)
createPublicGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.public-gateway.public-gateway.create

  • is.vpc.vpc.operate

  • is.floating-ip.floating-ip.create

    Required when floating_ip specifies a new floating IP

  • is.floating-ip.floating-ip.operate

    Required when floating_ip specifies an existing floating IP

Auditing

Calling this method generates the following auditing event.

  • is.public-gateway.public-gateway.create

Delete a public gateway

This request deletes a public gateway. This operation cannot be reversed. For this request to succeed, the public gateway must not be attached to any subnets. The public gateway's floating IP will be automatically unbound. If the floating IP was created when the public gateway was created, it will be deleted.

This request deletes a public gateway. This operation cannot be reversed. For this request to succeed, the public gateway must not be attached to any subnets. The public gateway's floating IP will be automatically unbound. If the floating IP was created when the public gateway was created, it will be deleted.

This request deletes a public gateway. This operation cannot be reversed. For this request to succeed, the public gateway must not be attached to any subnets. The public gateway's floating IP will be automatically unbound. If the floating IP was created when the public gateway was created, it will be deleted.

This request deletes a public gateway. This operation cannot be reversed. For this request to succeed, the public gateway must not be attached to any subnets. The public gateway's floating IP will be automatically unbound. If the floating IP was created when the public gateway was created, it will be deleted.

This request deletes a public gateway. This operation cannot be reversed. For this request to succeed, the public gateway must not be attached to any subnets. The public gateway's floating IP will be automatically unbound. If the floating IP was created when the public gateway was created, it will be deleted.

DELETE /public_gateways/{id}
(vpc *VpcV1) DeletePublicGateway(deletePublicGatewayOptions *DeletePublicGatewayOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeletePublicGatewayWithContext(ctx context.Context, deletePublicGatewayOptions *DeletePublicGatewayOptions) (response *core.DetailedResponse, err error)
delete_public_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deletePublicGateway(DeletePublicGatewayOptions deletePublicGatewayOptions)
deletePublicGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.public-gateway.public-gateway.delete

Auditing

Calling this method generates the following auditing event.

  • is.public-gateway.public-gateway.delete

Retrieve a public gateway

This request retrieves a single public gateway specified by the identifier in the URL.

This request retrieves a single public gateway specified by the identifier in the URL.

This request retrieves a single public gateway specified by the identifier in the URL.

This request retrieves a single public gateway specified by the identifier in the URL.

This request retrieves a single public gateway specified by the identifier in the URL.

GET /public_gateways/{id}
(vpc *VpcV1) GetPublicGateway(getPublicGatewayOptions *GetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetPublicGatewayWithContext(ctx context.Context, getPublicGatewayOptions *GetPublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
get_public_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PublicGateway> getPublicGateway(GetPublicGatewayOptions getPublicGatewayOptions)
getPublicGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.public-gateway.public-gateway.read

Auditing

Calling this method generates the following auditing event.

  • is.public-gateway.public-gateway.read

Update a public gateway

This request updates a public gateway's name.

This request updates a public gateway's name.

This request updates a public gateway's name.

This request updates a public gateway's name.

This request updates a public gateway's name.

PATCH /public_gateways/{id}
(vpc *VpcV1) UpdatePublicGateway(updatePublicGatewayOptions *UpdatePublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdatePublicGatewayWithContext(ctx context.Context, updatePublicGatewayOptions *UpdatePublicGatewayOptions) (result *PublicGateway, response *core.DetailedResponse, err error)
update_public_gateway(
        self,
        id: str,
        public_gateway_patch: 'PublicGatewayPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<PublicGateway> updatePublicGateway(UpdatePublicGatewayOptions updatePublicGatewayOptions)
updatePublicGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.public-gateway.public-gateway.update

Auditing

Calling this method generates the following auditing event.

  • is.public-gateway.public-gateway.update

List all floating IPs

This request lists all floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet to an instance.

This request lists all floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet to an instance.

This request lists all floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet to an instance.

This request lists all floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet to an instance.

This request lists all floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet to an instance.

GET /floating_ips
(vpc *VpcV1) ListFloatingIps(listFloatingIpsOptions *ListFloatingIpsOptions) (result *FloatingIPCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListFloatingIpsWithContext(ctx context.Context, listFloatingIpsOptions *ListFloatingIpsOptions) (result *FloatingIPCollection, response *core.DetailedResponse, err error)
list_floating_ips(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        sort: Optional[str] = None,
        target_id: Optional[str] = None,
        target_crn: Optional[str] = None,
        target_name: Optional[str] = None,
        target_resource_type: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIPCollection> listFloatingIps(ListFloatingIpsOptions listFloatingIpsOptions)
listFloatingIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.floating-ip.floating-ip.list

  • is.floating-ip.floating-ip.read

Auditing

Calling this method generates the following auditing event.

  • is.floating-ip.floating-ip.read

Reserve a floating IP

This request reserves a new floating IP.

This request reserves a new floating IP.

This request reserves a new floating IP.

This request reserves a new floating IP.

This request reserves a new floating IP.

POST /floating_ips
(vpc *VpcV1) CreateFloatingIP(createFloatingIPOptions *CreateFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateFloatingIPWithContext(ctx context.Context, createFloatingIPOptions *CreateFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
create_floating_ip(
        self,
        floating_ip_prototype: 'FloatingIPPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIP> createFloatingIp(CreateFloatingIpOptions createFloatingIpOptions)
createFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.floating-ip.floating-ip.create

  • is.bare-metal-server.bare-metal-server.operate

    Required when target specifies a bare metal server network interface

  • is.instance.instance.operate

    Required when target specifies an instance network interface

  • is.virtual-network-interface.virtual-network-interface.operate

    Required when target specifies a virtual network interface

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.floating-ip.floating-ip.create

  • is.floating-ip.floating-ip.attach

    Generated when target is specified

  • is.instance.network-interface.attach

    Generated when target specifies an instance network interface

  • is.bare-metal-server.network-interface.attach

    Generated when target specifies a bare metal server network interface

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated when target specifies a virtual network interface

Delete a floating IP

This request disassociates (if associated) and releases a floating IP. This operation cannot be reversed. For this request to succeed, the floating IP must not be required by another resource, such as a public gateway.

This request disassociates (if associated) and releases a floating IP. This operation cannot be reversed. For this request to succeed, the floating IP must not be required by another resource, such as a public gateway.

This request disassociates (if associated) and releases a floating IP. This operation cannot be reversed. For this request to succeed, the floating IP must not be required by another resource, such as a public gateway.

This request disassociates (if associated) and releases a floating IP. This operation cannot be reversed. For this request to succeed, the floating IP must not be required by another resource, such as a public gateway.

This request disassociates (if associated) and releases a floating IP. This operation cannot be reversed. For this request to succeed, the floating IP must not be required by another resource, such as a public gateway.

DELETE /floating_ips/{id}
(vpc *VpcV1) DeleteFloatingIP(deleteFloatingIPOptions *DeleteFloatingIPOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteFloatingIPWithContext(ctx context.Context, deleteFloatingIPOptions *DeleteFloatingIPOptions) (response *core.DetailedResponse, err error)
delete_floating_ip(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteFloatingIp(DeleteFloatingIpOptions deleteFloatingIpOptions)
deleteFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.floating-ip.floating-ip.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.floating-ip.floating-ip.delete

  • is.floating-ip.floating-ip.detach

    Generated for a floating IP that was attached

  • is.bare-metal-server.network-interface.detach

    Generated for a floating IP that was attached to a bare metal server network interface

  • is.instance.network-interface.detach

    Generated for a floating IP that was attached to an instance network interface

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated for a floating IP that was attached to a virtual network interface

Retrieve a floating IP

This request retrieves a single floating IP specified by the identifier in the URL.

This request retrieves a single floating IP specified by the identifier in the URL.

This request retrieves a single floating IP specified by the identifier in the URL.

This request retrieves a single floating IP specified by the identifier in the URL.

This request retrieves a single floating IP specified by the identifier in the URL.

GET /floating_ips/{id}
(vpc *VpcV1) GetFloatingIP(getFloatingIPOptions *GetFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetFloatingIPWithContext(ctx context.Context, getFloatingIPOptions *GetFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
get_floating_ip(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIP> getFloatingIp(GetFloatingIpOptions getFloatingIpOptions)
getFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.floating-ip.floating-ip.read

Auditing

Calling this method generates the following auditing event.

  • is.floating-ip.floating-ip.read

Update a floating IP

This request updates a floating IP's name and/or target.

This request updates a floating IP's name and/or target.

This request updates a floating IP's name and/or target.

This request updates a floating IP's name and/or target.

This request updates a floating IP's name and/or target.

PATCH /floating_ips/{id}
(vpc *VpcV1) UpdateFloatingIP(updateFloatingIPOptions *UpdateFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateFloatingIPWithContext(ctx context.Context, updateFloatingIPOptions *UpdateFloatingIPOptions) (result *FloatingIP, response *core.DetailedResponse, err error)
update_floating_ip(
        self,
        id: str,
        floating_ip_patch: 'FloatingIPPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FloatingIP> updateFloatingIp(UpdateFloatingIpOptions updateFloatingIpOptions)
updateFloatingIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.floating-ip.floating-ip.update

  • is.floating-ip.floating-ip.operate

    Required when target is specified

  • is.bare-metal-server.bare-metal-server.operate

    Required when target is changed to or from a bare metal server network interface

  • is.instance.instance.operate

    Required when target is changed to or from an instance network interface

  • is.virtual-network-interface.virtual-network-interface.operate

    Required when target is changed to or from a virtual network interface

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.floating-ip.floating-ip.update

  • is.floating-ip.floating-ip.attach

    Generated when target is specified

  • is.floating-ip.floating-ip.detach

    Generated when an existing target is replaced

  • is.bare-metal-server.network-interface.attach

    Generated when target specifies a bare metal server network interface

  • is.bare-metal-server.network-interface.detach

    Generated when an existing bare metal server network interface target is replaced

  • is.instance.network-interface.attach

    Generated when target specifies an instance network interface

  • is.instance.network-interface.detach

    Generated when an existing instance network interface target is replaced

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated when target specifies a virtual network interface

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated when an existing virtual network interface target is replaced

List all network ACLs

This request lists all network ACLs in the region. A network ACL defines a set of packet filtering (5-tuple) rules for all traffic in and out of a subnet. Both allow and deny rules can be defined, and rules are stateless such that reverse traffic in response to allowed traffic is not automatically permitted.

This request lists all network ACLs in the region. A network ACL defines a set of packet filtering (5-tuple) rules for all traffic in and out of a subnet. Both allow and deny rules can be defined, and rules are stateless such that reverse traffic in response to allowed traffic is not automatically permitted.

This request lists all network ACLs in the region. A network ACL defines a set of packet filtering (5-tuple) rules for all traffic in and out of a subnet. Both allow and deny rules can be defined, and rules are stateless such that reverse traffic in response to allowed traffic is not automatically permitted.

This request lists all network ACLs in the region. A network ACL defines a set of packet filtering (5-tuple) rules for all traffic in and out of a subnet. Both allow and deny rules can be defined, and rules are stateless such that reverse traffic in response to allowed traffic is not automatically permitted.

This request lists all network ACLs in the region. A network ACL defines a set of packet filtering (5-tuple) rules for all traffic in and out of a subnet. Both allow and deny rules can be defined, and rules are stateless such that reverse traffic in response to allowed traffic is not automatically permitted.

GET /network_acls
(vpc *VpcV1) ListNetworkAcls(listNetworkAclsOptions *ListNetworkAclsOptions) (result *NetworkACLCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListNetworkAclsWithContext(ctx context.Context, listNetworkAclsOptions *ListNetworkAclsOptions) (result *NetworkACLCollection, response *core.DetailedResponse, err error)
list_network_acls(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACLCollection> listNetworkAcls(ListNetworkAclsOptions listNetworkAclsOptions)
listNetworkAcls(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.list

  • is.network-acl.network-acl.read

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.network-acl.read

Create a network ACL

This request creates a new stateless network ACL from a network ACL prototype object. The prototype object is structured in the same way as a retrieved network ACL, and contains the information necessary to create the new network ACL.

This request creates a new stateless network ACL from a network ACL prototype object. The prototype object is structured in the same way as a retrieved network ACL, and contains the information necessary to create the new network ACL.

This request creates a new stateless network ACL from a network ACL prototype object. The prototype object is structured in the same way as a retrieved network ACL, and contains the information necessary to create the new network ACL.

This request creates a new stateless network ACL from a network ACL prototype object. The prototype object is structured in the same way as a retrieved network ACL, and contains the information necessary to create the new network ACL.

This request creates a new stateless network ACL from a network ACL prototype object. The prototype object is structured in the same way as a retrieved network ACL, and contains the information necessary to create the new network ACL.

POST /network_acls
(vpc *VpcV1) CreateNetworkACL(createNetworkACLOptions *CreateNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateNetworkACLWithContext(ctx context.Context, createNetworkACLOptions *CreateNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
create_network_acl(
        self,
        network_acl_prototype: 'NetworkACLPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACL> createNetworkAcl(CreateNetworkAclOptions createNetworkAclOptions)
createNetworkAcl(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.create

  • is.network-acl.network-acl.read

    Required when source_network_acl is specified

  • is.vpc.vpc.operate

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.network-acl.create

Delete a network ACL

This request deletes a network ACL. This operation cannot be reversed. For this request to succeed, the network ACL must not be the default network ACL for any VPCs, and the network ACL must not be attached to any subnets.

This request deletes a network ACL. This operation cannot be reversed. For this request to succeed, the network ACL must not be the default network ACL for any VPCs, and the network ACL must not be attached to any subnets.

This request deletes a network ACL. This operation cannot be reversed. For this request to succeed, the network ACL must not be the default network ACL for any VPCs, and the network ACL must not be attached to any subnets.

This request deletes a network ACL. This operation cannot be reversed. For this request to succeed, the network ACL must not be the default network ACL for any VPCs, and the network ACL must not be attached to any subnets.

This request deletes a network ACL. This operation cannot be reversed. For this request to succeed, the network ACL must not be the default network ACL for any VPCs, and the network ACL must not be attached to any subnets.

DELETE /network_acls/{id}
(vpc *VpcV1) DeleteNetworkACL(deleteNetworkACLOptions *DeleteNetworkACLOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteNetworkACLWithContext(ctx context.Context, deleteNetworkACLOptions *DeleteNetworkACLOptions) (response *core.DetailedResponse, err error)
delete_network_acl(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteNetworkAcl(DeleteNetworkAclOptions deleteNetworkAclOptions)
deleteNetworkAcl(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.delete

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.network-acl.delete

Retrieve a network ACL

This request retrieves a single network ACL specified by the identifier in the URL.

This request retrieves a single network ACL specified by the identifier in the URL.

This request retrieves a single network ACL specified by the identifier in the URL.

This request retrieves a single network ACL specified by the identifier in the URL.

This request retrieves a single network ACL specified by the identifier in the URL.

GET /network_acls/{id}
(vpc *VpcV1) GetNetworkACL(getNetworkACLOptions *GetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetNetworkACLWithContext(ctx context.Context, getNetworkACLOptions *GetNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
get_network_acl(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACL> getNetworkAcl(GetNetworkAclOptions getNetworkAclOptions)
getNetworkAcl(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.read

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.network-acl.read

Update a network ACL

This request updates a network ACL's name.

This request updates a network ACL's name.

This request updates a network ACL's name.

This request updates a network ACL's name.

This request updates a network ACL's name.

PATCH /network_acls/{id}
(vpc *VpcV1) UpdateNetworkACL(updateNetworkACLOptions *UpdateNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateNetworkACLWithContext(ctx context.Context, updateNetworkACLOptions *UpdateNetworkACLOptions) (result *NetworkACL, response *core.DetailedResponse, err error)
update_network_acl(
        self,
        id: str,
        network_acl_patch: 'NetworkACLPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACL> updateNetworkAcl(UpdateNetworkAclOptions updateNetworkAclOptions)
updateNetworkAcl(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.update

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.network-acl.update

List all rules for a network ACL

This request lists all rules for a network ACL. These rules can allow or deny traffic between a source CIDR block and a destination CIDR block over a particular protocol and port range.

This request lists all rules for a network ACL. These rules can allow or deny traffic between a source CIDR block and a destination CIDR block over a particular protocol and port range.

This request lists all rules for a network ACL. These rules can allow or deny traffic between a source CIDR block and a destination CIDR block over a particular protocol and port range.

This request lists all rules for a network ACL. These rules can allow or deny traffic between a source CIDR block and a destination CIDR block over a particular protocol and port range.

This request lists all rules for a network ACL. These rules can allow or deny traffic between a source CIDR block and a destination CIDR block over a particular protocol and port range.

GET /network_acls/{network_acl_id}/rules
(vpc *VpcV1) ListNetworkACLRules(listNetworkACLRulesOptions *ListNetworkACLRulesOptions) (result *NetworkACLRuleCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListNetworkACLRulesWithContext(ctx context.Context, listNetworkACLRulesOptions *ListNetworkACLRulesOptions) (result *NetworkACLRuleCollection, response *core.DetailedResponse, err error)
list_network_acl_rules(
        self,
        network_acl_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        direction: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACLRuleCollection> listNetworkAclRules(ListNetworkAclRulesOptions listNetworkAclRulesOptions)
listNetworkAclRules(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.read

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.rule.read

Create a rule for a network ACL

This request creates a new rule from a network ACL rule prototype object. The prototype object is structured in the same way as a retrieved rule, and contains the information necessary to create the new rule.

This request creates a new rule from a network ACL rule prototype object. The prototype object is structured in the same way as a retrieved rule, and contains the information necessary to create the new rule.

This request creates a new rule from a network ACL rule prototype object. The prototype object is structured in the same way as a retrieved rule, and contains the information necessary to create the new rule.

This request creates a new rule from a network ACL rule prototype object. The prototype object is structured in the same way as a retrieved rule, and contains the information necessary to create the new rule.

This request creates a new rule from a network ACL rule prototype object. The prototype object is structured in the same way as a retrieved rule, and contains the information necessary to create the new rule.

POST /network_acls/{network_acl_id}/rules
(vpc *VpcV1) CreateNetworkACLRule(createNetworkACLRuleOptions *CreateNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateNetworkACLRuleWithContext(ctx context.Context, createNetworkACLRuleOptions *CreateNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error)
create_network_acl_rule(
        self,
        network_acl_id: str,
        network_acl_rule_prototype: 'NetworkACLRulePrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACLRule> createNetworkAclRule(CreateNetworkAclRuleOptions createNetworkAclRuleOptions)
createNetworkAclRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.update

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.rule.create

Delete a network ACL rule

This request deletes a rule. This operation cannot be reversed.

This request deletes a rule. This operation cannot be reversed.

This request deletes a rule. This operation cannot be reversed.

This request deletes a rule. This operation cannot be reversed.

This request deletes a rule. This operation cannot be reversed.

DELETE /network_acls/{network_acl_id}/rules/{id}
(vpc *VpcV1) DeleteNetworkACLRule(deleteNetworkACLRuleOptions *DeleteNetworkACLRuleOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteNetworkACLRuleWithContext(ctx context.Context, deleteNetworkACLRuleOptions *DeleteNetworkACLRuleOptions) (response *core.DetailedResponse, err error)
delete_network_acl_rule(
        self,
        network_acl_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteNetworkAclRule(DeleteNetworkAclRuleOptions deleteNetworkAclRuleOptions)
deleteNetworkAclRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.update

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.rule.delete

Retrieve a network ACL rule

This request retrieves a single rule specified by the identifier in the URL.

This request retrieves a single rule specified by the identifier in the URL.

This request retrieves a single rule specified by the identifier in the URL.

This request retrieves a single rule specified by the identifier in the URL.

This request retrieves a single rule specified by the identifier in the URL.

GET /network_acls/{network_acl_id}/rules/{id}
(vpc *VpcV1) GetNetworkACLRule(getNetworkACLRuleOptions *GetNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetNetworkACLRuleWithContext(ctx context.Context, getNetworkACLRuleOptions *GetNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error)
get_network_acl_rule(
        self,
        network_acl_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACLRule> getNetworkAclRule(GetNetworkAclRuleOptions getNetworkAclRuleOptions)
getNetworkAclRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.read

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.rule.read

Update a network ACL rule

This request updates a rule with the information in a provided rule patch. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

This request updates a rule with the information in a provided rule patch. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

This request updates a rule with the information in a provided rule patch. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

This request updates a rule with the information in a provided rule patch. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

This request updates a rule with the information in a provided rule patch. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

PATCH /network_acls/{network_acl_id}/rules/{id}
(vpc *VpcV1) UpdateNetworkACLRule(updateNetworkACLRuleOptions *UpdateNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateNetworkACLRuleWithContext(ctx context.Context, updateNetworkACLRuleOptions *UpdateNetworkACLRuleOptions) (result NetworkACLRuleIntf, response *core.DetailedResponse, err error)
update_network_acl_rule(
        self,
        network_acl_id: str,
        id: str,
        network_acl_rule_patch: 'NetworkACLRulePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<NetworkACLRule> updateNetworkAclRule(UpdateNetworkAclRuleOptions updateNetworkAclRuleOptions)
updateNetworkAclRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.network-acl.network-acl.update

Auditing

Calling this method generates the following auditing event.

  • is.network-acl.rule.update

List all security groups

This request lists all security groups in the region. Security groups provide a way to apply IP filtering rules to instances in the associated VPC. With security groups, all traffic is denied by default, and rules added to security groups define which traffic the security group permits. Security group rules are stateful such that reverse traffic in response to allowed traffic is automatically permitted.

This request lists all security groups in the region. Security groups provide a way to apply IP filtering rules to instances in the associated VPC. With security groups, all traffic is denied by default, and rules added to security groups define which traffic the security group permits. Security group rules are stateful such that reverse traffic in response to allowed traffic is automatically permitted.

This request lists all security groups in the region. Security groups provide a way to apply IP filtering rules to instances in the associated VPC. With security groups, all traffic is denied by default, and rules added to security groups define which traffic the security group permits. Security group rules are stateful such that reverse traffic in response to allowed traffic is automatically permitted.

This request lists all security groups in the region. Security groups provide a way to apply IP filtering rules to instances in the associated VPC. With security groups, all traffic is denied by default, and rules added to security groups define which traffic the security group permits. Security group rules are stateful such that reverse traffic in response to allowed traffic is automatically permitted.

This request lists all security groups in the region. Security groups provide a way to apply IP filtering rules to instances in the associated VPC. With security groups, all traffic is denied by default, and rules added to security groups define which traffic the security group permits. Security group rules are stateful such that reverse traffic in response to allowed traffic is automatically permitted.

GET /security_groups
(vpc *VpcV1) ListSecurityGroups(listSecurityGroupsOptions *ListSecurityGroupsOptions) (result *SecurityGroupCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSecurityGroupsWithContext(ctx context.Context, listSecurityGroupsOptions *ListSecurityGroupsOptions) (result *SecurityGroupCollection, response *core.DetailedResponse, err error)
list_security_groups(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_crn: Optional[str] = None,
        vpc_name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroupCollection> listSecurityGroups(ListSecurityGroupsOptions listSecurityGroupsOptions)
listSecurityGroups(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.list

  • is.security-group.security-group.read

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group.read

Create a security group

This request creates a new security group from a security group prototype object. The prototype object is structured in the same way as a retrieved security group, and contains the information necessary to create the new security group. If security group rules are included in the prototype object, those rules will be added to the security group. Each security group is scoped to one VPC. Only resources in that VPC can be added to the security group.

This request creates a new security group from a security group prototype object. The prototype object is structured in the same way as a retrieved security group, and contains the information necessary to create the new security group. If security group rules are included in the prototype object, those rules will be added to the security group. Each security group is scoped to one VPC. Only resources in that VPC can be added to the security group.

This request creates a new security group from a security group prototype object. The prototype object is structured in the same way as a retrieved security group, and contains the information necessary to create the new security group. If security group rules are included in the prototype object, those rules will be added to the security group. Each security group is scoped to one VPC. Only resources in that VPC can be added to the security group.

This request creates a new security group from a security group prototype object. The prototype object is structured in the same way as a retrieved security group, and contains the information necessary to create the new security group. If security group rules are included in the prototype object, those rules will be added to the security group. Each security group is scoped to one VPC. Only resources in that VPC can be added to the security group.

This request creates a new security group from a security group prototype object. The prototype object is structured in the same way as a retrieved security group, and contains the information necessary to create the new security group. If security group rules are included in the prototype object, those rules will be added to the security group. Each security group is scoped to one VPC. Only resources in that VPC can be added to the security group.

POST /security_groups
(vpc *VpcV1) CreateSecurityGroup(createSecurityGroupOptions *CreateSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateSecurityGroupWithContext(ctx context.Context, createSecurityGroupOptions *CreateSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error)
create_security_group(
        self,
        vpc: 'VPCIdentity',
        *,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        rules: Optional[List['SecurityGroupRulePrototype']] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroup> createSecurityGroup(CreateSecurityGroupOptions createSecurityGroupOptions)
createSecurityGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.create

  • is.vpc.vpc.operate

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group.create

Delete a security group

This request deletes a security group. A security group cannot be deleted if it is referenced by any security group targets or rules. Additionally, a VPC's default security group cannot be deleted. This operation cannot be reversed.

This request deletes a security group. A security group cannot be deleted if it is referenced by any security group targets or rules. Additionally, a VPC's default security group cannot be deleted. This operation cannot be reversed.

This request deletes a security group. A security group cannot be deleted if it is referenced by any security group targets or rules. Additionally, a VPC's default security group cannot be deleted. This operation cannot be reversed.

This request deletes a security group. A security group cannot be deleted if it is referenced by any security group targets or rules. Additionally, a VPC's default security group cannot be deleted. This operation cannot be reversed.

This request deletes a security group. A security group cannot be deleted if it is referenced by any security group targets or rules. Additionally, a VPC's default security group cannot be deleted. This operation cannot be reversed.

DELETE /security_groups/{id}
(vpc *VpcV1) DeleteSecurityGroup(deleteSecurityGroupOptions *DeleteSecurityGroupOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSecurityGroupWithContext(ctx context.Context, deleteSecurityGroupOptions *DeleteSecurityGroupOptions) (response *core.DetailedResponse, err error)
delete_security_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteSecurityGroup(DeleteSecurityGroupOptions deleteSecurityGroupOptions)
deleteSecurityGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.delete

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group.delete

Retrieve a security group

This request retrieves a single security group specified by the identifier in the URL path.

This request retrieves a single security group specified by the identifier in the URL path.

This request retrieves a single security group specified by the identifier in the URL path.

This request retrieves a single security group specified by the identifier in the URL path.

This request retrieves a single security group specified by the identifier in the URL path.

GET /security_groups/{id}
(vpc *VpcV1) GetSecurityGroup(getSecurityGroupOptions *GetSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSecurityGroupWithContext(ctx context.Context, getSecurityGroupOptions *GetSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error)
get_security_group(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroup> getSecurityGroup(GetSecurityGroupOptions getSecurityGroupOptions)
getSecurityGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.read

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group.read

Update a security group

This request updates a security group with the information provided in a security group patch object. The security group patch object is structured in the same way as a retrieved security group and contains only the information to be updated.

This request updates a security group with the information provided in a security group patch object. The security group patch object is structured in the same way as a retrieved security group and contains only the information to be updated.

This request updates a security group with the information provided in a security group patch object. The security group patch object is structured in the same way as a retrieved security group and contains only the information to be updated.

This request updates a security group with the information provided in a security group patch object. The security group patch object is structured in the same way as a retrieved security group and contains only the information to be updated.

This request updates a security group with the information provided in a security group patch object. The security group patch object is structured in the same way as a retrieved security group and contains only the information to be updated.

PATCH /security_groups/{id}
(vpc *VpcV1) UpdateSecurityGroup(updateSecurityGroupOptions *UpdateSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateSecurityGroupWithContext(ctx context.Context, updateSecurityGroupOptions *UpdateSecurityGroupOptions) (result *SecurityGroup, response *core.DetailedResponse, err error)
update_security_group(
        self,
        id: str,
        security_group_patch: 'SecurityGroupPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroup> updateSecurityGroup(UpdateSecurityGroupOptions updateSecurityGroupOptions)
updateSecurityGroup(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.update

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group.update

List all rules in a security group

This request lists all rules in a security group. These rules define what traffic the security group permits. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted.

This request lists all rules in a security group. These rules define what traffic the security group permits. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted.

This request lists all rules in a security group. These rules define what traffic the security group permits. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted.

This request lists all rules in a security group. These rules define what traffic the security group permits. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted.

This request lists all rules in a security group. These rules define what traffic the security group permits. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted.

GET /security_groups/{security_group_id}/rules
(vpc *VpcV1) ListSecurityGroupRules(listSecurityGroupRulesOptions *ListSecurityGroupRulesOptions) (result *SecurityGroupRuleCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSecurityGroupRulesWithContext(ctx context.Context, listSecurityGroupRulesOptions *ListSecurityGroupRulesOptions) (result *SecurityGroupRuleCollection, response *core.DetailedResponse, err error)
list_security_group_rules(
        self,
        security_group_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroupRuleCollection> listSecurityGroupRules(ListSecurityGroupRulesOptions listSecurityGroupRulesOptions)
listSecurityGroupRules(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.read

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group-rule.read

Create a rule for a security group

This request creates a new security group rule from a security group rule prototype object. The prototype object is structured in the same way as a retrieved security group rule and contains the information necessary to create the rule. As part of creating a new rule in a security group, the rule is applied to all the networking interfaces in the security group. Rules specify which IP traffic a security group will allow. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted. A rule allowing inbound TCP traffic on port 80 also allows outbound TCP traffic on port 80 without the need for an additional rule.

This request creates a new security group rule from a security group rule prototype object. The prototype object is structured in the same way as a retrieved security group rule and contains the information necessary to create the rule. As part of creating a new rule in a security group, the rule is applied to all the networking interfaces in the security group. Rules specify which IP traffic a security group will allow. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted. A rule allowing inbound TCP traffic on port 80 also allows outbound TCP traffic on port 80 without the need for an additional rule.

This request creates a new security group rule from a security group rule prototype object. The prototype object is structured in the same way as a retrieved security group rule and contains the information necessary to create the rule. As part of creating a new rule in a security group, the rule is applied to all the networking interfaces in the security group. Rules specify which IP traffic a security group will allow. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted. A rule allowing inbound TCP traffic on port 80 also allows outbound TCP traffic on port 80 without the need for an additional rule.

This request creates a new security group rule from a security group rule prototype object. The prototype object is structured in the same way as a retrieved security group rule and contains the information necessary to create the rule. As part of creating a new rule in a security group, the rule is applied to all the networking interfaces in the security group. Rules specify which IP traffic a security group will allow. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted. A rule allowing inbound TCP traffic on port 80 also allows outbound TCP traffic on port 80 without the need for an additional rule.

This request creates a new security group rule from a security group rule prototype object. The prototype object is structured in the same way as a retrieved security group rule and contains the information necessary to create the rule. As part of creating a new rule in a security group, the rule is applied to all the networking interfaces in the security group. Rules specify which IP traffic a security group will allow. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted. A rule allowing inbound TCP traffic on port 80 also allows outbound TCP traffic on port 80 without the need for an additional rule.

POST /security_groups/{security_group_id}/rules
(vpc *VpcV1) CreateSecurityGroupRule(createSecurityGroupRuleOptions *CreateSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateSecurityGroupRuleWithContext(ctx context.Context, createSecurityGroupRuleOptions *CreateSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error)
create_security_group_rule(
        self,
        security_group_id: str,
        security_group_rule_prototype: 'SecurityGroupRulePrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroupRule> createSecurityGroupRule(CreateSecurityGroupRuleOptions createSecurityGroupRuleOptions)
createSecurityGroupRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.update

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group-rule.create

Delete a security group rule

This request deletes a security group rule. This operation cannot be reversed. Removing a security group rule will not end existing connections allowed by that rule.

This request deletes a security group rule. This operation cannot be reversed. Removing a security group rule will not end existing connections allowed by that rule.

This request deletes a security group rule. This operation cannot be reversed. Removing a security group rule will not end existing connections allowed by that rule.

This request deletes a security group rule. This operation cannot be reversed. Removing a security group rule will not end existing connections allowed by that rule.

This request deletes a security group rule. This operation cannot be reversed. Removing a security group rule will not end existing connections allowed by that rule.

DELETE /security_groups/{security_group_id}/rules/{id}
(vpc *VpcV1) DeleteSecurityGroupRule(deleteSecurityGroupRuleOptions *DeleteSecurityGroupRuleOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSecurityGroupRuleWithContext(ctx context.Context, deleteSecurityGroupRuleOptions *DeleteSecurityGroupRuleOptions) (response *core.DetailedResponse, err error)
delete_security_group_rule(
        self,
        security_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteSecurityGroupRule(DeleteSecurityGroupRuleOptions deleteSecurityGroupRuleOptions)
deleteSecurityGroupRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.update

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group-rule.delete

Retrieve a security group rule

This request retrieves a single security group rule specified by the identifier in the URL path.

This request retrieves a single security group rule specified by the identifier in the URL path.

This request retrieves a single security group rule specified by the identifier in the URL path.

This request retrieves a single security group rule specified by the identifier in the URL path.

This request retrieves a single security group rule specified by the identifier in the URL path.

GET /security_groups/{security_group_id}/rules/{id}
(vpc *VpcV1) GetSecurityGroupRule(getSecurityGroupRuleOptions *GetSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSecurityGroupRuleWithContext(ctx context.Context, getSecurityGroupRuleOptions *GetSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error)
get_security_group_rule(
        self,
        security_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroupRule> getSecurityGroupRule(GetSecurityGroupRuleOptions getSecurityGroupRuleOptions)
getSecurityGroupRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.read

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group-rule.read

Update a security group rule

This request updates a security group rule with the information in a provided rule patch object. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

This request updates a security group rule with the information in a provided rule patch object. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

This request updates a security group rule with the information in a provided rule patch object. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

This request updates a security group rule with the information in a provided rule patch object. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

This request updates a security group rule with the information in a provided rule patch object. The rule patch object contains only the information to be updated. The request will fail if the information is not applicable to the rule's protocol.

PATCH /security_groups/{security_group_id}/rules/{id}
(vpc *VpcV1) UpdateSecurityGroupRule(updateSecurityGroupRuleOptions *UpdateSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateSecurityGroupRuleWithContext(ctx context.Context, updateSecurityGroupRuleOptions *UpdateSecurityGroupRuleOptions) (result SecurityGroupRuleIntf, response *core.DetailedResponse, err error)
update_security_group_rule(
        self,
        security_group_id: str,
        id: str,
        security_group_rule_patch: 'SecurityGroupRulePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroupRule> updateSecurityGroupRule(UpdateSecurityGroupRuleOptions updateSecurityGroupRuleOptions)
updateSecurityGroupRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.update

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group-rule.update

List all targets associated with a security group

This request lists all targets associated with a security group, to which the rules in the security group are applied.

This request lists all targets associated with a security group, to which the rules in the security group are applied.

This request lists all targets associated with a security group, to which the rules in the security group are applied.

This request lists all targets associated with a security group, to which the rules in the security group are applied.

This request lists all targets associated with a security group, to which the rules in the security group are applied.

GET /security_groups/{security_group_id}/targets
(vpc *VpcV1) ListSecurityGroupTargets(listSecurityGroupTargetsOptions *ListSecurityGroupTargetsOptions) (result *SecurityGroupTargetCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListSecurityGroupTargetsWithContext(ctx context.Context, listSecurityGroupTargetsOptions *ListSecurityGroupTargetsOptions) (result *SecurityGroupTargetCollection, response *core.DetailedResponse, err error)
list_security_group_targets(
        self,
        security_group_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroupTargetCollection> listSecurityGroupTargets(ListSecurityGroupTargetsOptions listSecurityGroupTargetsOptions)
listSecurityGroupTargets(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.read

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group.read

Remove a target from a security group

This request removes a target from a security group. For this request to succeed, the target must be attached to at least one other security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

Security groups are stateful, so any changes to a target's security groups are applied to new connections. Existing connections are not affected.

This request removes a target from a security group. For this request to succeed, the target must be attached to at least one other security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

Security groups are stateful, so any changes to a target's security groups are applied to new connections. Existing connections are not affected.

This request removes a target from a security group. For this request to succeed, the target must be attached to at least one other security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

Security groups are stateful, so any changes to a target's security groups are applied to new connections. Existing connections are not affected.

This request removes a target from a security group. For this request to succeed, the target must be attached to at least one other security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

Security groups are stateful, so any changes to a target's security groups are applied to new connections. Existing connections are not affected.

This request removes a target from a security group. For this request to succeed, the target must be attached to at least one other security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

Security groups are stateful, so any changes to a target's security groups are applied to new connections. Existing connections are not affected.

DELETE /security_groups/{security_group_id}/targets/{id}
(vpc *VpcV1) DeleteSecurityGroupTargetBinding(deleteSecurityGroupTargetBindingOptions *DeleteSecurityGroupTargetBindingOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteSecurityGroupTargetBindingWithContext(ctx context.Context, deleteSecurityGroupTargetBindingOptions *DeleteSecurityGroupTargetBindingOptions) (response *core.DetailedResponse, err error)
delete_security_group_target_binding(
        self,
        security_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteSecurityGroupTargetBinding(DeleteSecurityGroupTargetBindingOptions deleteSecurityGroupTargetBindingOptions)
deleteSecurityGroupTargetBinding(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.operate

  • is.instance.instance.operate

    Required when target specifies an instance network interface

  • is.bare-metal-server.bare-metal-server.operate

    Required when target specifies a bare metal server network interface

  • is.virtual-network-interface.virtual-network-interface.operate

    Required when target specifies a virtual network interface

  • is.load-balancer.load-balancer.manage

    Required when target specifies a load balancer

  • is.endpoint-gateway.endpoint-gateway.operate

    Required when target specifies an endpoint gateway

  • is.vpn-server.vpn-server.operate

    Required when target specifies a VPN server

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.endpoint-gateway.endpoint-gateway.update

    Generated when target specifies an endpoint gateway

  • is.instance.network-interface.update

    Generated when target specifies an instance network interface

  • is.bare-metal-server.network-interface.update

    Generated when target specifies a bare metal server network interface

  • is.load-balancer.load-balancer.update

    Generated when target specifies a load balancer

  • is.vpn-server.vpn-server.update

    Generated when target specifies a VPN server

  • is.security-group.security-group.detach

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated when target specifies a virtual network interface

Retrieve a security group target

This request retrieves a single target specified by the identifier in the URL path. The target must be an existing target of the security group.

This request retrieves a single target specified by the identifier in the URL path. The target must be an existing target of the security group.

This request retrieves a single target specified by the identifier in the URL path. The target must be an existing target of the security group.

This request retrieves a single target specified by the identifier in the URL path. The target must be an existing target of the security group.

This request retrieves a single target specified by the identifier in the URL path. The target must be an existing target of the security group.

GET /security_groups/{security_group_id}/targets/{id}
(vpc *VpcV1) GetSecurityGroupTarget(getSecurityGroupTargetOptions *GetSecurityGroupTargetOptions) (result SecurityGroupTargetReferenceIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetSecurityGroupTargetWithContext(ctx context.Context, getSecurityGroupTargetOptions *GetSecurityGroupTargetOptions) (result SecurityGroupTargetReferenceIntf, response *core.DetailedResponse, err error)
get_security_group_target(
        self,
        security_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroupTargetReference> getSecurityGroupTarget(GetSecurityGroupTargetOptions getSecurityGroupTargetOptions)
getSecurityGroupTarget(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.read

Auditing

Calling this method generates the following auditing event.

  • is.security-group.security-group.read

Add a target to a security group

This request adds a resource to an existing security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

When a target is added to a security group, the security group rules are applied to the target. A request body is not required, and if provided, is ignored.

This request adds a resource to an existing security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

When a target is added to a security group, the security group rules are applied to the target. A request body is not required, and if provided, is ignored.

This request adds a resource to an existing security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

When a target is added to a security group, the security group rules are applied to the target. A request body is not required, and if provided, is ignored.

This request adds a resource to an existing security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

When a target is added to a security group, the security group rules are applied to the target. A request body is not required, and if provided, is ignored.

This request adds a resource to an existing security group. The specified target identifier can be:

  • A bare metal server network interface identifier
  • A virtual network interface identifier
  • A VPN server identifier
  • A load balancer identifier
  • An endpoint gateway identifier
  • An instance network interface identifier

When a target is added to a security group, the security group rules are applied to the target. A request body is not required, and if provided, is ignored.

PUT /security_groups/{security_group_id}/targets/{id}
(vpc *VpcV1) CreateSecurityGroupTargetBinding(createSecurityGroupTargetBindingOptions *CreateSecurityGroupTargetBindingOptions) (result SecurityGroupTargetReferenceIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateSecurityGroupTargetBindingWithContext(ctx context.Context, createSecurityGroupTargetBindingOptions *CreateSecurityGroupTargetBindingOptions) (result SecurityGroupTargetReferenceIntf, response *core.DetailedResponse, err error)
create_security_group_target_binding(
        self,
        security_group_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<SecurityGroupTargetReference> createSecurityGroupTargetBinding(CreateSecurityGroupTargetBindingOptions createSecurityGroupTargetBindingOptions)
createSecurityGroupTargetBinding(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.security-group.security-group.operate

  • is.instance.instance.operate

    Required when target specifies an instance network interface

  • is.bare-metal-server.bare-metal-server.operate

    Required when target specifies a bare metal server network interface

  • is.virtual-network-interface.virtual-network-interface.operate

    Required when target specifies a virtual network interface

  • is.load-balancer.load-balancer.manage

    Required when target specifies a load balancer

  • is.endpoint-gateway.endpoint-gateway.operate

    Required when target specifies an endpoint gateway

  • is.vpn-server.vpn-server.operate

    Required when target specifies a VPN server

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.endpoint-gateway.endpoint-gateway.update

    Generated when target specifies an endpoint gateway

  • is.instance.network-interface.update

    Generated when target specifies an instance network interface

  • is.bare-metal-server.network-interface.update

    Generated when target specifies a bare metal server network interface

  • is.load-balancer.load-balancer.update

    Generated when target specifies a load balancer

  • is.vpn-server.vpn-server.update

    Generated when target specifies a VPN server

  • is.security-group.security-group.attach

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated when target specifies a virtual network interface

List all IKE policies

This request lists all IKE policies in the region.

This request lists all IKE policies in the region.

This request lists all IKE policies in the region.

This request lists all IKE policies in the region.

This request lists all IKE policies in the region.

GET /ike_policies
(vpc *VpcV1) ListIkePolicies(listIkePoliciesOptions *ListIkePoliciesOptions) (result *IkePolicyCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListIkePoliciesWithContext(ctx context.Context, listIkePoliciesOptions *ListIkePoliciesOptions) (result *IkePolicyCollection, response *core.DetailedResponse, err error)
list_ike_policies(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<IKEPolicyCollection> listIkePolicies(ListIkePoliciesOptions listIkePoliciesOptions)
listIkePolicies(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.list

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ike-policy.list

Create an IKE policy

This request creates a new IKE policy.

This request creates a new IKE policy.

This request creates a new IKE policy.

This request creates a new IKE policy.

This request creates a new IKE policy.

POST /ike_policies
(vpc *VpcV1) CreateIkePolicy(createIkePolicyOptions *CreateIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateIkePolicyWithContext(ctx context.Context, createIkePolicyOptions *CreateIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error)
create_ike_policy(
        self,
        authentication_algorithm: str,
        dh_group: int,
        encryption_algorithm: str,
        ike_version: int,
        *,
        key_lifetime: Optional[int] = None,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<IKEPolicy> createIkePolicy(CreateIkePolicyOptions createIkePolicyOptions)
createIkePolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.create

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ike-policy.create

Delete an IKE policy

This request deletes an IKE policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

This request deletes an IKE policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

This request deletes an IKE policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

This request deletes an IKE policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

This request deletes an IKE policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

DELETE /ike_policies/{id}
(vpc *VpcV1) DeleteIkePolicy(deleteIkePolicyOptions *DeleteIkePolicyOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteIkePolicyWithContext(ctx context.Context, deleteIkePolicyOptions *DeleteIkePolicyOptions) (response *core.DetailedResponse, err error)
delete_ike_policy(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteIkePolicy(DeleteIkePolicyOptions deleteIkePolicyOptions)
deleteIkePolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.delete

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ike-policy.delete

Retrieve an IKE policy

This request retrieves a single IKE policy specified by the identifier in the URL.

This request retrieves a single IKE policy specified by the identifier in the URL.

This request retrieves a single IKE policy specified by the identifier in the URL.

This request retrieves a single IKE policy specified by the identifier in the URL.

This request retrieves a single IKE policy specified by the identifier in the URL.

GET /ike_policies/{id}
(vpc *VpcV1) GetIkePolicy(getIkePolicyOptions *GetIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetIkePolicyWithContext(ctx context.Context, getIkePolicyOptions *GetIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error)
get_ike_policy(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<IKEPolicy> getIkePolicy(GetIkePolicyOptions getIkePolicyOptions)
getIkePolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ike-policy.read

Update an IKE policy

This request updates the properties of an existing IKE policy.

This request updates the properties of an existing IKE policy.

This request updates the properties of an existing IKE policy.

This request updates the properties of an existing IKE policy.

This request updates the properties of an existing IKE policy.

PATCH /ike_policies/{id}
(vpc *VpcV1) UpdateIkePolicy(updateIkePolicyOptions *UpdateIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateIkePolicyWithContext(ctx context.Context, updateIkePolicyOptions *UpdateIkePolicyOptions) (result *IkePolicy, response *core.DetailedResponse, err error)
update_ike_policy(
        self,
        id: str,
        ike_policy_patch: 'IKEPolicyPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<IKEPolicy> updateIkePolicy(UpdateIkePolicyOptions updateIkePolicyOptions)
updateIkePolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.update

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ike-policy.update

List all VPN gateway connections that use a specified IKE policy

This request lists all VPN gateway connections that use a policy

This request lists all VPN gateway connections that use a policy.

This request lists all VPN gateway connections that use a policy.

This request lists all VPN gateway connections that use a policy.

This request lists all VPN gateway connections that use a policy.

GET /ike_policies/{id}/connections
(vpc *VpcV1) ListIkePolicyConnections(listIkePolicyConnectionsOptions *ListIkePolicyConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListIkePolicyConnectionsWithContext(ctx context.Context, listIkePolicyConnectionsOptions *ListIkePolicyConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error)
list_ike_policy_connections(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayConnectionCollection> listIkePolicyConnections(ListIkePolicyConnectionsOptions listIkePolicyConnectionsOptions)
listIkePolicyConnections(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.list

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection.list

List all IPsec policies

This request lists all IPsec policies in the region.

This request lists all IPsec policies in the region.

This request lists all IPsec policies in the region.

This request lists all IPsec policies in the region.

This request lists all IPsec policies in the region.

GET /ipsec_policies
(vpc *VpcV1) ListIpsecPolicies(listIpsecPoliciesOptions *ListIpsecPoliciesOptions) (result *IPsecPolicyCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListIpsecPoliciesWithContext(ctx context.Context, listIpsecPoliciesOptions *ListIpsecPoliciesOptions) (result *IPsecPolicyCollection, response *core.DetailedResponse, err error)
list_ipsec_policies(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<IPsecPolicyCollection> listIpsecPolicies(ListIpsecPoliciesOptions listIpsecPoliciesOptions)
listIpsecPolicies(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.list

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ipsec-policy.list

Create an IPsec policy

This request creates a new IPsec policy.

This request creates a new IPsec policy.

This request creates a new IPsec policy.

This request creates a new IPsec policy.

This request creates a new IPsec policy.

POST /ipsec_policies
(vpc *VpcV1) CreateIpsecPolicy(createIpsecPolicyOptions *CreateIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateIpsecPolicyWithContext(ctx context.Context, createIpsecPolicyOptions *CreateIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error)
create_ipsec_policy(
        self,
        authentication_algorithm: str,
        encryption_algorithm: str,
        pfs: str,
        *,
        key_lifetime: Optional[int] = None,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<IPsecPolicy> createIpsecPolicy(CreateIpsecPolicyOptions createIpsecPolicyOptions)
createIpsecPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.create

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ipsec-policy.create

Delete an IPsec policy

This request deletes an IPsec policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

This request deletes an IPsec policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

This request deletes an IPsec policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

This request deletes an IPsec policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

This request deletes an IPsec policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.

DELETE /ipsec_policies/{id}
(vpc *VpcV1) DeleteIpsecPolicy(deleteIpsecPolicyOptions *DeleteIpsecPolicyOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteIpsecPolicyWithContext(ctx context.Context, deleteIpsecPolicyOptions *DeleteIpsecPolicyOptions) (response *core.DetailedResponse, err error)
delete_ipsec_policy(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteIpsecPolicy(DeleteIpsecPolicyOptions deleteIpsecPolicyOptions)
deleteIpsecPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.delete

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ipsec-policy.delete

Retrieve an IPsec policy

This request retrieves a single IPsec policy specified by the identifier in the URL.

This request retrieves a single IPsec policy specified by the identifier in the URL.

This request retrieves a single IPsec policy specified by the identifier in the URL.

This request retrieves a single IPsec policy specified by the identifier in the URL.

This request retrieves a single IPsec policy specified by the identifier in the URL.

GET /ipsec_policies/{id}
(vpc *VpcV1) GetIpsecPolicy(getIpsecPolicyOptions *GetIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetIpsecPolicyWithContext(ctx context.Context, getIpsecPolicyOptions *GetIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error)
get_ipsec_policy(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<IPsecPolicy> getIpsecPolicy(GetIpsecPolicyOptions getIpsecPolicyOptions)
getIpsecPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ipsec-policy.read

Update an IPsec policy

This request updates the properties of an existing IPsec policy.

This request updates the properties of an existing IPsec policy.

This request updates the properties of an existing IPsec policy.

This request updates the properties of an existing IPsec policy.

This request updates the properties of an existing IPsec policy.

PATCH /ipsec_policies/{id}
(vpc *VpcV1) UpdateIpsecPolicy(updateIpsecPolicyOptions *UpdateIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateIpsecPolicyWithContext(ctx context.Context, updateIpsecPolicyOptions *UpdateIpsecPolicyOptions) (result *IPsecPolicy, response *core.DetailedResponse, err error)
update_ipsec_policy(
        self,
        id: str,
        i_psec_policy_patch: 'IPsecPolicyPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<IPsecPolicy> updateIpsecPolicy(UpdateIpsecPolicyOptions updateIpsecPolicyOptions)
updateIpsecPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.update

Auditing

Calling this method generates the following auditing event.

  • is.vpn.ipsec-policy.update

List all VPN gateway connections that use a specified IPsec policy

This request lists all VPN gateway connections that use a policy

This request lists all VPN gateway connections that use a policy.

This request lists all VPN gateway connections that use a policy.

This request lists all VPN gateway connections that use a policy.

This request lists all VPN gateway connections that use a policy.

GET /ipsec_policies/{id}/connections
(vpc *VpcV1) ListIpsecPolicyConnections(listIpsecPolicyConnectionsOptions *ListIpsecPolicyConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListIpsecPolicyConnectionsWithContext(ctx context.Context, listIpsecPolicyConnectionsOptions *ListIpsecPolicyConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error)
list_ipsec_policy_connections(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayConnectionCollection> listIpsecPolicyConnections(ListIpsecPolicyConnectionsOptions listIpsecPolicyConnectionsOptions)
listIpsecPolicyConnections(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.list

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection.list

List all VPN gateways

This request lists all VPN gateways in the region.

This request lists all VPN gateways in the region.

This request lists all VPN gateways in the region.

This request lists all VPN gateways in the region.

This request lists all VPN gateways in the region.

GET /vpn_gateways
(vpc *VpcV1) ListVPNGateways(listVPNGatewaysOptions *ListVPNGatewaysOptions) (result *VPNGatewayCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPNGatewaysWithContext(ctx context.Context, listVPNGatewaysOptions *ListVPNGatewaysOptions) (result *VPNGatewayCollection, response *core.DetailedResponse, err error)
list_vpn_gateways(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        sort: Optional[str] = None,
        mode: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayCollection> listVpnGateways(ListVpnGatewaysOptions listVpnGatewaysOptions)
listVpnGateways(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.list

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-gateway.list

Create a VPN gateway

This request creates a new VPN gateway.

This request creates a new VPN gateway.

This request creates a new VPN gateway.

This request creates a new VPN gateway.

This request creates a new VPN gateway.

POST /vpn_gateways
(vpc *VpcV1) CreateVPNGateway(createVPNGatewayOptions *CreateVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPNGatewayWithContext(ctx context.Context, createVPNGatewayOptions *CreateVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error)
create_vpn_gateway(
        self,
        vpn_gateway_prototype: 'VPNGatewayPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGateway> createVpnGateway(CreateVpnGatewayOptions createVpnGatewayOptions)
createVpnGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.create

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-gateway.create

Delete a VPN gateway

This request deletes a VPN gateway. This operation cannot be reversed. For this request to succeed, the VPN gateway must not have a status of pending, and there must not be any VPC routes using the VPN gateway's connections as a next hop.

This request deletes a VPN gateway. This operation cannot be reversed. For this request to succeed, the VPN gateway must not have a status of pending, and there must not be any VPC routes using the VPN gateway's connections as a next hop.

This request deletes a VPN gateway. This operation cannot be reversed. For this request to succeed, the VPN gateway must not have a status of pending, and there must not be any VPC routes using the VPN gateway's connections as a next hop.

This request deletes a VPN gateway. This operation cannot be reversed. For this request to succeed, the VPN gateway must not have a status of pending, and there must not be any VPC routes using the VPN gateway's connections as a next hop.

This request deletes a VPN gateway. This operation cannot be reversed. For this request to succeed, the VPN gateway must not have a status of pending, and there must not be any VPC routes using the VPN gateway's connections as a next hop.

DELETE /vpn_gateways/{id}
(vpc *VpcV1) DeleteVPNGateway(deleteVPNGatewayOptions *DeleteVPNGatewayOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPNGatewayWithContext(ctx context.Context, deleteVPNGatewayOptions *DeleteVPNGatewayOptions) (response *core.DetailedResponse, err error)
delete_vpn_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpnGateway(DeleteVpnGatewayOptions deleteVpnGatewayOptions)
deleteVpnGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.delete

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-gateway.delete

Retrieve a VPN gateway

This request retrieves a single VPN gateway specified by the identifier in the URL.

This request retrieves a single VPN gateway specified by the identifier in the URL.

This request retrieves a single VPN gateway specified by the identifier in the URL.

This request retrieves a single VPN gateway specified by the identifier in the URL.

This request retrieves a single VPN gateway specified by the identifier in the URL.

GET /vpn_gateways/{id}
(vpc *VpcV1) GetVPNGateway(getVPNGatewayOptions *GetVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPNGatewayWithContext(ctx context.Context, getVPNGatewayOptions *GetVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error)
get_vpn_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGateway> getVpnGateway(GetVpnGatewayOptions getVpnGatewayOptions)
getVpnGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-gateway.read

Update a VPN gateway

This request updates the properties of an existing VPN gateway.

This request updates the properties of an existing VPN gateway.

This request updates the properties of an existing VPN gateway.

This request updates the properties of an existing VPN gateway.

This request updates the properties of an existing VPN gateway.

PATCH /vpn_gateways/{id}
(vpc *VpcV1) UpdateVPNGateway(updateVPNGatewayOptions *UpdateVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPNGatewayWithContext(ctx context.Context, updateVPNGatewayOptions *UpdateVPNGatewayOptions) (result VPNGatewayIntf, response *core.DetailedResponse, err error)
update_vpn_gateway(
        self,
        id: str,
        vpn_gateway_patch: 'VPNGatewayPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGateway> updateVpnGateway(UpdateVpnGatewayOptions updateVpnGatewayOptions)
updateVpnGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.update

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-gateway.update

List all connections of a VPN gateway

This request lists all connections of a VPN gateway.

This request lists all connections of a VPN gateway.

This request lists all connections of a VPN gateway.

This request lists all connections of a VPN gateway.

This request lists all connections of a VPN gateway.

GET /vpn_gateways/{vpn_gateway_id}/connections
(vpc *VpcV1) ListVPNGatewayConnections(listVPNGatewayConnectionsOptions *ListVPNGatewayConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPNGatewayConnectionsWithContext(ctx context.Context, listVPNGatewayConnectionsOptions *ListVPNGatewayConnectionsOptions) (result *VPNGatewayConnectionCollection, response *core.DetailedResponse, err error)
list_vpn_gateway_connections(
        self,
        vpn_gateway_id: str,
        *,
        status: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayConnectionCollection> listVpnGatewayConnections(ListVpnGatewayConnectionsOptions listVpnGatewayConnectionsOptions)
listVpnGatewayConnections(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.list

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection.list

Create a connection for a VPN gateway

This request creates a new VPN gateway connection.

This request creates a new VPN gateway connection.

This request creates a new VPN gateway connection.

This request creates a new VPN gateway connection.

This request creates a new VPN gateway connection.

POST /vpn_gateways/{vpn_gateway_id}/connections
(vpc *VpcV1) CreateVPNGatewayConnection(createVPNGatewayConnectionOptions *CreateVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPNGatewayConnectionWithContext(ctx context.Context, createVPNGatewayConnectionOptions *CreateVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error)
create_vpn_gateway_connection(
        self,
        vpn_gateway_id: str,
        vpn_gateway_connection_prototype: 'VPNGatewayConnectionPrototype',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayConnection> createVpnGatewayConnection(CreateVpnGatewayConnectionOptions createVpnGatewayConnectionOptions)
createVpnGatewayConnection(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.create

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection.create

Delete a VPN gateway connection

This request deletes a VPN gateway connection. This operation cannot be reversed. For this request to succeed, there must not be VPC routes using this VPN connection as a next hop.

This request deletes a VPN gateway connection. This operation cannot be reversed. For this request to succeed, there must not be VPC routes using this VPN connection as a next hop.

This request deletes a VPN gateway connection. This operation cannot be reversed. For this request to succeed, there must not be VPC routes using this VPN connection as a next hop.

This request deletes a VPN gateway connection. This operation cannot be reversed. For this request to succeed, there must not be VPC routes using this VPN connection as a next hop.

This request deletes a VPN gateway connection. This operation cannot be reversed. For this request to succeed, there must not be VPC routes using this VPN connection as a next hop.

DELETE /vpn_gateways/{vpn_gateway_id}/connections/{id}
(vpc *VpcV1) DeleteVPNGatewayConnection(deleteVPNGatewayConnectionOptions *DeleteVPNGatewayConnectionOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPNGatewayConnectionWithContext(ctx context.Context, deleteVPNGatewayConnectionOptions *DeleteVPNGatewayConnectionOptions) (response *core.DetailedResponse, err error)
delete_vpn_gateway_connection(
        self,
        vpn_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpnGatewayConnection(DeleteVpnGatewayConnectionOptions deleteVpnGatewayConnectionOptions)
deleteVpnGatewayConnection(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.delete

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection.delete

Retrieve a VPN gateway connection

This request retrieves a single VPN gateway connection specified by the identifier in the URL.

This request retrieves a single VPN gateway connection specified by the identifier in the URL.

This request retrieves a single VPN gateway connection specified by the identifier in the URL.

This request retrieves a single VPN gateway connection specified by the identifier in the URL.

This request retrieves a single VPN gateway connection specified by the identifier in the URL.

GET /vpn_gateways/{vpn_gateway_id}/connections/{id}
(vpc *VpcV1) GetVPNGatewayConnection(getVPNGatewayConnectionOptions *GetVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPNGatewayConnectionWithContext(ctx context.Context, getVPNGatewayConnectionOptions *GetVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error)
get_vpn_gateway_connection(
        self,
        vpn_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayConnection> getVpnGatewayConnection(GetVpnGatewayConnectionOptions getVpnGatewayConnectionOptions)
getVpnGatewayConnection(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection.read

Update a VPN gateway connection

This request updates the properties of an existing VPN gateway connection.

This request updates the properties of an existing VPN gateway connection.

This request updates the properties of an existing VPN gateway connection.

This request updates the properties of an existing VPN gateway connection.

This request updates the properties of an existing VPN gateway connection.

PATCH /vpn_gateways/{vpn_gateway_id}/connections/{id}
(vpc *VpcV1) UpdateVPNGatewayConnection(updateVPNGatewayConnectionOptions *UpdateVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPNGatewayConnectionWithContext(ctx context.Context, updateVPNGatewayConnectionOptions *UpdateVPNGatewayConnectionOptions) (result VPNGatewayConnectionIntf, response *core.DetailedResponse, err error)
update_vpn_gateway_connection(
        self,
        vpn_gateway_id: str,
        id: str,
        vpn_gateway_connection_patch: 'VPNGatewayConnectionPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayConnection> updateVpnGatewayConnection(UpdateVpnGatewayConnectionOptions updateVpnGatewayConnectionOptions)
updateVpnGatewayConnection(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.update

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection.update

List all local CIDRs for a VPN gateway connection

This request lists all local CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request lists all local CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request lists all local CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request lists all local CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request lists all local CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

GET /vpn_gateways/{vpn_gateway_id}/connections/{id}/local_cidrs
(vpc *VpcV1) ListVPNGatewayConnectionLocalCidrs(listVPNGatewayConnectionLocalCidrsOptions *ListVPNGatewayConnectionLocalCidrsOptions) (result *VPNGatewayConnectionLocalCidRs, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPNGatewayConnectionLocalCidrsWithContext(ctx context.Context, listVPNGatewayConnectionLocalCidrsOptions *ListVPNGatewayConnectionLocalCidrsOptions) (result *VPNGatewayConnectionLocalCidRs, response *core.DetailedResponse, err error)
list_vpn_gateway_connection_local_cidrs(
        self,
        vpn_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayConnectionLocalCIDRs> listVpnGatewayConnectionLocalCidrs(ListVpnGatewayConnectionLocalCidrsOptions listVpnGatewayConnectionLocalCidrsOptions)
listVpnGatewayConnectionLocalCidrs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.list

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection-local-cidr.list

Remove a local CIDR from a VPN gateway connection

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

DELETE /vpn_gateways/{vpn_gateway_id}/connections/{id}/local_cidrs/{cidr_prefix}/{prefix_length}
(vpc *VpcV1) RemoveVPNGatewayConnectionLocalCIDR(removeVPNGatewayConnectionLocalCIDROptions *RemoveVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) RemoveVPNGatewayConnectionLocalCIDRWithContext(ctx context.Context, removeVPNGatewayConnectionLocalCIDROptions *RemoveVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error)
remove_vpn_gateway_connection_local_cidr(
        self,
        vpn_gateway_id: str,
        id: str,
        cidr_prefix: str,
        prefix_length: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> removeVpnGatewayConnectionLocalCidr(RemoveVpnGatewayConnectionLocalCidrOptions removeVpnGatewayConnectionLocalCidrOptions)
removeVpnGatewayConnectionLocalCidr(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.delete

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection-local-cidr.delete

Check if the specified local CIDR exists on a VPN gateway connection

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

GET /vpn_gateways/{vpn_gateway_id}/connections/{id}/local_cidrs/{cidr_prefix}/{prefix_length}
(vpc *VpcV1) CheckVPNGatewayConnectionLocalCIDR(checkVPNGatewayConnectionLocalCIDROptions *CheckVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) CheckVPNGatewayConnectionLocalCIDRWithContext(ctx context.Context, checkVPNGatewayConnectionLocalCIDROptions *CheckVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error)
check_vpn_gateway_connection_local_cidr(
        self,
        vpn_gateway_id: str,
        id: str,
        cidr_prefix: str,
        prefix_length: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> checkVpnGatewayConnectionLocalCidr(CheckVpnGatewayConnectionLocalCidrOptions checkVpnGatewayConnectionLocalCidrOptions)
checkVpnGatewayConnectionLocalCidr(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection-local-cidr.read

Set a local CIDR on a VPN gateway connection

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

PUT /vpn_gateways/{vpn_gateway_id}/connections/{id}/local_cidrs/{cidr_prefix}/{prefix_length}
(vpc *VpcV1) AddVPNGatewayConnectionLocalCIDR(addVPNGatewayConnectionLocalCIDROptions *AddVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) AddVPNGatewayConnectionLocalCIDRWithContext(ctx context.Context, addVPNGatewayConnectionLocalCIDROptions *AddVPNGatewayConnectionLocalCIDROptions) (response *core.DetailedResponse, err error)
add_vpn_gateway_connection_local_cidr(
        self,
        vpn_gateway_id: str,
        id: str,
        cidr_prefix: str,
        prefix_length: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> addVpnGatewayConnectionLocalCidr(AddVpnGatewayConnectionLocalCidrOptions addVpnGatewayConnectionLocalCidrOptions)
addVpnGatewayConnectionLocalCidr(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.create

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection-local-cidr.create

List all peer CIDRs for a VPN gateway connection

This request lists all peer CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request lists all peer CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request lists all peer CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request lists all peer CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request lists all peer CIDRs for a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

GET /vpn_gateways/{vpn_gateway_id}/connections/{id}/peer_cidrs
(vpc *VpcV1) ListVPNGatewayConnectionPeerCidrs(listVPNGatewayConnectionPeerCidrsOptions *ListVPNGatewayConnectionPeerCidrsOptions) (result *VPNGatewayConnectionPeerCidRs, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPNGatewayConnectionPeerCidrsWithContext(ctx context.Context, listVPNGatewayConnectionPeerCidrsOptions *ListVPNGatewayConnectionPeerCidrsOptions) (result *VPNGatewayConnectionPeerCidRs, response *core.DetailedResponse, err error)
list_vpn_gateway_connection_peer_cidrs(
        self,
        vpn_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNGatewayConnectionPeerCIDRs> listVpnGatewayConnectionPeerCidrs(ListVpnGatewayConnectionPeerCidrsOptions listVpnGatewayConnectionPeerCidrsOptions)
listVpnGatewayConnectionPeerCidrs(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.list

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection-peer-cidr.list

Remove a peer CIDR from a VPN gateway connection

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

This request removes a CIDR from a VPN gateway connection.

This request is only supported for policy mode VPN gateways.

DELETE /vpn_gateways/{vpn_gateway_id}/connections/{id}/peer_cidrs/{cidr_prefix}/{prefix_length}
(vpc *VpcV1) RemoveVPNGatewayConnectionPeerCIDR(removeVPNGatewayConnectionPeerCIDROptions *RemoveVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) RemoveVPNGatewayConnectionPeerCIDRWithContext(ctx context.Context, removeVPNGatewayConnectionPeerCIDROptions *RemoveVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error)
remove_vpn_gateway_connection_peer_cidr(
        self,
        vpn_gateway_id: str,
        id: str,
        cidr_prefix: str,
        prefix_length: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> removeVpnGatewayConnectionPeerCidr(RemoveVpnGatewayConnectionPeerCidrOptions removeVpnGatewayConnectionPeerCidrOptions)
removeVpnGatewayConnectionPeerCidr(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.delete

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection-peer-cidr.delete

Check if the specified peer CIDR exists on a VPN gateway connection

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise.

This request is only supported for policy mode VPN gateways.

GET /vpn_gateways/{vpn_gateway_id}/connections/{id}/peer_cidrs/{cidr_prefix}/{prefix_length}
(vpc *VpcV1) CheckVPNGatewayConnectionPeerCIDR(checkVPNGatewayConnectionPeerCIDROptions *CheckVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) CheckVPNGatewayConnectionPeerCIDRWithContext(ctx context.Context, checkVPNGatewayConnectionPeerCIDROptions *CheckVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error)
check_vpn_gateway_connection_peer_cidr(
        self,
        vpn_gateway_id: str,
        id: str,
        cidr_prefix: str,
        prefix_length: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> checkVpnGatewayConnectionPeerCidr(CheckVpnGatewayConnectionPeerCidrOptions checkVpnGatewayConnectionPeerCidrOptions)
checkVpnGatewayConnectionPeerCidr(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection-peer-cidr.read

Set a peer CIDR on a VPN gateway connection

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored.

This request is only supported for policy mode VPN gateways.

PUT /vpn_gateways/{vpn_gateway_id}/connections/{id}/peer_cidrs/{cidr_prefix}/{prefix_length}
(vpc *VpcV1) AddVPNGatewayConnectionPeerCIDR(addVPNGatewayConnectionPeerCIDROptions *AddVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) AddVPNGatewayConnectionPeerCIDRWithContext(ctx context.Context, addVPNGatewayConnectionPeerCIDROptions *AddVPNGatewayConnectionPeerCIDROptions) (response *core.DetailedResponse, err error)
add_vpn_gateway_connection_peer_cidr(
        self,
        vpn_gateway_id: str,
        id: str,
        cidr_prefix: str,
        prefix_length: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> addVpnGatewayConnectionPeerCidr(AddVpnGatewayConnectionPeerCidrOptions addVpnGatewayConnectionPeerCidrOptions)
addVpnGatewayConnectionPeerCidr(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.vpn.vpn.read

  • is.vpn.vpn.create

Auditing

Calling this method generates the following auditing event.

  • is.vpn.vpn-connection-peer-cidr.create

List all VPN servers

This request lists all VPN servers.

This request lists all VPN servers.

This request lists all VPN servers.

This request lists all VPN servers.

This request lists all VPN servers.

GET /vpn_servers
(vpc *VpcV1) ListVPNServers(listVPNServersOptions *ListVPNServersOptions) (result *VPNServerCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPNServersWithContext(ctx context.Context, listVPNServersOptions *ListVPNServersOptions) (result *VPNServerCollection, response *core.DetailedResponse, err error)
list_vpn_servers(
        self,
        *,
        name: Optional[str] = None,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        sort: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServerCollection> listVpnServers(ListVpnServersOptions listVpnServersOptions)
listVpnServers(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server.list

Create a VPN server

This request creates a new VPN server.

This request creates a new VPN server.

This request creates a new VPN server.

This request creates a new VPN server.

This request creates a new VPN server.

POST /vpn_servers
(vpc *VpcV1) CreateVPNServer(createVPNServerOptions *CreateVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPNServerWithContext(ctx context.Context, createVPNServerOptions *CreateVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error)
create_vpn_server(
        self,
        certificate: 'CertificateInstanceIdentity',
        client_authentication: List['VPNServerAuthenticationPrototype'],
        client_ip_pool: str,
        subnets: List['SubnetIdentity'],
        *,
        client_dns_server_ips: Optional[List['IP']] = None,
        client_idle_timeout: Optional[int] = None,
        enable_split_tunneling: Optional[bool] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        protocol: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        security_groups: Optional[List['SecurityGroupIdentity']] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServer> createVpnServer(CreateVpnServerOptions createVpnServerOptions)
createVpnServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.create

  • is.security-group.security-group.operate

  • is.subnet.subnet.update

    Required for any subnet on which subnets specifies a new reserved IP on a subnet

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server.create

Delete a VPN server

This request deletes a VPN server. This operation cannot be reversed.

This request deletes a VPN server. This operation cannot be reversed.

This request deletes a VPN server. This operation cannot be reversed.

This request deletes a VPN server. This operation cannot be reversed.

This request deletes a VPN server. This operation cannot be reversed.

DELETE /vpn_servers/{id}
(vpc *VpcV1) DeleteVPNServer(deleteVPNServerOptions *DeleteVPNServerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPNServerWithContext(ctx context.Context, deleteVPNServerOptions *DeleteVPNServerOptions) (response *core.DetailedResponse, err error)
delete_vpn_server(
        self,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpnServer(DeleteVpnServerOptions deleteVpnServerOptions)
deleteVpnServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.delete

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server.delete

Retrieve a VPN server

This request retrieves a single VPN server specified by the identifier in the URL.

This request retrieves a single VPN server specified by the identifier in the URL.

This request retrieves a single VPN server specified by the identifier in the URL.

This request retrieves a single VPN server specified by the identifier in the URL.

This request retrieves a single VPN server specified by the identifier in the URL.

GET /vpn_servers/{id}
(vpc *VpcV1) GetVPNServer(getVPNServerOptions *GetVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPNServerWithContext(ctx context.Context, getVPNServerOptions *GetVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error)
get_vpn_server(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServer> getVpnServer(GetVpnServerOptions getVpnServerOptions)
getVpnServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server.read

Update a VPN server

This request updates the properties of an existing VPN server. Any property changes will cause all connected VPN clients are disconnected from this VPN server except for the name change.

This request updates the properties of an existing VPN server. Any property changes will cause all connected VPN clients are disconnected from this VPN server except for the name change.

This request updates the properties of an existing VPN server. Any property changes will cause all connected VPN clients are disconnected from this VPN server except for the name change.

This request updates the properties of an existing VPN server. Any property changes will cause all connected VPN clients are disconnected from this VPN server except for the name change.

This request updates the properties of an existing VPN server. Any property changes will cause all connected VPN clients are disconnected from this VPN server except for the name change.

PATCH /vpn_servers/{id}
(vpc *VpcV1) UpdateVPNServer(updateVPNServerOptions *UpdateVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPNServerWithContext(ctx context.Context, updateVPNServerOptions *UpdateVPNServerOptions) (result *VPNServer, response *core.DetailedResponse, err error)
update_vpn_server(
        self,
        id: str,
        vpn_server_patch: 'VPNServerPatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServer> updateVpnServer(UpdateVpnServerOptions updateVpnServerOptions)
updateVpnServer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.update

  • is.subnet.subnet.update

    Required for any subnet on which subnets specifies a new reserved IP on a subnet

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server.update

Retrieve client configuration

This request retrieves OpenVPN client configuration on a single VPN server specified by the identifier in the URL. This configuration includes directives compatible with OpenVPN releases 2.4 and 2.5

This request retrieves OpenVPN client configuration on a single VPN server specified by the identifier in the URL. This configuration includes directives compatible with OpenVPN releases 2.4 and 2.5.

This request retrieves OpenVPN client configuration on a single VPN server specified by the identifier in the URL. This configuration includes directives compatible with OpenVPN releases 2.4 and 2.5.

This request retrieves OpenVPN client configuration on a single VPN server specified by the identifier in the URL. This configuration includes directives compatible with OpenVPN releases 2.4 and 2.5.

This request retrieves OpenVPN client configuration on a single VPN server specified by the identifier in the URL. This configuration includes directives compatible with OpenVPN releases 2.4 and 2.5.

GET /vpn_servers/{id}/client_configuration
(vpc *VpcV1) GetVPNServerClientConfiguration(getVPNServerClientConfigurationOptions *GetVPNServerClientConfigurationOptions) (result *string, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPNServerClientConfigurationWithContext(ctx context.Context, getVPNServerClientConfigurationOptions *GetVPNServerClientConfigurationOptions) (result *string, response *core.DetailedResponse, err error)
get_vpn_server_client_configuration(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<String> getVpnServerClientConfiguration(GetVpnServerClientConfigurationOptions getVpnServerClientConfigurationOptions)
getVpnServerClientConfiguration(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-configuration.read

List all VPN clients for a VPN server

This request retrieves all connected VPN clients, and any disconnected VPN clients that the VPN server has not yet deleted based on its auto-deletion policy.

This request retrieves all connected VPN clients, and any disconnected VPN clients that the VPN server has not yet deleted based on its auto-deletion policy.

This request retrieves all connected VPN clients, and any disconnected VPN clients that the VPN server has not yet deleted based on its auto-deletion policy.

This request retrieves all connected VPN clients, and any disconnected VPN clients that the VPN server has not yet deleted based on its auto-deletion policy.

This request retrieves all connected VPN clients, and any disconnected VPN clients that the VPN server has not yet deleted based on its auto-deletion policy.

GET /vpn_servers/{vpn_server_id}/clients
(vpc *VpcV1) ListVPNServerClients(listVPNServerClientsOptions *ListVPNServerClientsOptions) (result *VPNServerClientCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPNServerClientsWithContext(ctx context.Context, listVPNServerClientsOptions *ListVPNServerClientsOptions) (result *VPNServerClientCollection, response *core.DetailedResponse, err error)
list_vpn_server_clients(
        self,
        vpn_server_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        sort: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServerClientCollection> listVpnServerClients(ListVpnServerClientsOptions listVpnServerClientsOptions)
listVpnServerClients(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-client.list

Delete a VPN client

This request disconnects and deletes the VPN client from the VPN server. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

This request disconnects and deletes the VPN client from the VPN server. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

This request disconnects and deletes the VPN client from the VPN server. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

This request disconnects and deletes the VPN client from the VPN server. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

This request disconnects and deletes the VPN client from the VPN server. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

DELETE /vpn_servers/{vpn_server_id}/clients/{id}
(vpc *VpcV1) DeleteVPNServerClient(deleteVPNServerClientOptions *DeleteVPNServerClientOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPNServerClientWithContext(ctx context.Context, deleteVPNServerClientOptions *DeleteVPNServerClientOptions) (response *core.DetailedResponse, err error)
delete_vpn_server_client(
        self,
        vpn_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpnServerClient(DeleteVpnServerClientOptions deleteVpnServerClientOptions)
deleteVpnServerClient(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.operate

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-client.delete

Retrieve a VPN client

This request retrieves a single VPN client specified by the identifier in the URL.

This request retrieves a single VPN client specified by the identifier in the URL.

This request retrieves a single VPN client specified by the identifier in the URL.

This request retrieves a single VPN client specified by the identifier in the URL.

This request retrieves a single VPN client specified by the identifier in the URL.

GET /vpn_servers/{vpn_server_id}/clients/{id}
(vpc *VpcV1) GetVPNServerClient(getVPNServerClientOptions *GetVPNServerClientOptions) (result *VPNServerClient, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPNServerClientWithContext(ctx context.Context, getVPNServerClientOptions *GetVPNServerClientOptions) (result *VPNServerClient, response *core.DetailedResponse, err error)
get_vpn_server_client(
        self,
        vpn_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServerClient> getVpnServerClient(GetVpnServerClientOptions getVpnServerClientOptions)
getVpnServerClient(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-client.read

Disconnect a VPN client

This request disconnects the specified VPN client, and deletes the client according to the VPN server's auto-deletion policy. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

This request disconnects the specified VPN client, and deletes the client according to the VPN server's auto-deletion policy. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

This request disconnects the specified VPN client, and deletes the client according to the VPN server's auto-deletion policy. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

This request disconnects the specified VPN client, and deletes the client according to the VPN server's auto-deletion policy. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

This request disconnects the specified VPN client, and deletes the client according to the VPN server's auto-deletion policy. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.

POST /vpn_servers/{vpn_server_id}/clients/{id}/disconnect
(vpc *VpcV1) DisconnectVPNClient(disconnectVPNClientOptions *DisconnectVPNClientOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DisconnectVPNClientWithContext(ctx context.Context, disconnectVPNClientOptions *DisconnectVPNClientOptions) (response *core.DetailedResponse, err error)
disconnect_vpn_client(
        self,
        vpn_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> disconnectVpnClient(DisconnectVpnClientOptions disconnectVpnClientOptions)
disconnectVpnClient(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.operate

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-client.disconnect

List all VPN routes for a VPN server

This request lists all VPN routes in a VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server.

This request lists all VPN routes in a VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server.

This request lists all VPN routes in a VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server.

This request lists all VPN routes in a VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server.

This request lists all VPN routes in a VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server.

GET /vpn_servers/{vpn_server_id}/routes
(vpc *VpcV1) ListVPNServerRoutes(listVPNServerRoutesOptions *ListVPNServerRoutesOptions) (result *VPNServerRouteCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListVPNServerRoutesWithContext(ctx context.Context, listVPNServerRoutesOptions *ListVPNServerRoutesOptions) (result *VPNServerRouteCollection, response *core.DetailedResponse, err error)
list_vpn_server_routes(
        self,
        vpn_server_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        sort: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServerRouteCollection> listVpnServerRoutes(ListVpnServerRoutesOptions listVpnServerRoutesOptions)
listVpnServerRoutes(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-route.list

Create a VPN route for a VPN server

This request creates a new VPN route in the VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server. destination of the packet.

This request creates a new VPN route in the VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server. destination of the packet.

This request creates a new VPN route in the VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server. destination of the packet.

This request creates a new VPN route in the VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server. destination of the packet.

This request creates a new VPN route in the VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server. destination of the packet.

POST /vpn_servers/{vpn_server_id}/routes
(vpc *VpcV1) CreateVPNServerRoute(createVPNServerRouteOptions *CreateVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateVPNServerRouteWithContext(ctx context.Context, createVPNServerRouteOptions *CreateVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error)
create_vpn_server_route(
        self,
        vpn_server_id: str,
        destination: str,
        *,
        action: Optional[str] = None,
        name: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServerRoute> createVpnServerRoute(CreateVpnServerRouteOptions createVpnServerRouteOptions)
createVpnServerRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.update

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-route.create

Delete a VPN route

This request deletes a VPN route. This operation cannot be reversed.

This request deletes a VPN route. This operation cannot be reversed.

This request deletes a VPN route. This operation cannot be reversed.

This request deletes a VPN route. This operation cannot be reversed.

This request deletes a VPN route. This operation cannot be reversed.

DELETE /vpn_servers/{vpn_server_id}/routes/{id}
(vpc *VpcV1) DeleteVPNServerRoute(deleteVPNServerRouteOptions *DeleteVPNServerRouteOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteVPNServerRouteWithContext(ctx context.Context, deleteVPNServerRouteOptions *DeleteVPNServerRouteOptions) (response *core.DetailedResponse, err error)
delete_vpn_server_route(
        self,
        vpn_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteVpnServerRoute(DeleteVpnServerRouteOptions deleteVpnServerRouteOptions)
deleteVpnServerRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.update

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-route.delete

Retrieve a VPN route

This request retrieves a single VPN route specified by the identifier in the URL.

This request retrieves a single VPN route specified by the identifier in the URL.

This request retrieves a single VPN route specified by the identifier in the URL.

This request retrieves a single VPN route specified by the identifier in the URL.

This request retrieves a single VPN route specified by the identifier in the URL.

GET /vpn_servers/{vpn_server_id}/routes/{id}
(vpc *VpcV1) GetVPNServerRoute(getVPNServerRouteOptions *GetVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetVPNServerRouteWithContext(ctx context.Context, getVPNServerRouteOptions *GetVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error)
get_vpn_server_route(
        self,
        vpn_server_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServerRoute> getVpnServerRoute(GetVpnServerRouteOptions getVpnServerRouteOptions)
getVpnServerRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.read

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-route.read

Update a VPN route

This request updates a VPN route with the information in a provided VPN route patch. The VPN route patch object is structured in the same way as a retrieved VPN route and contains only the information to be updated.

This request updates a VPN route with the information in a provided VPN route patch. The VPN route patch object is structured in the same way as a retrieved VPN route and contains only the information to be updated.

This request updates a VPN route with the information in a provided VPN route patch. The VPN route patch object is structured in the same way as a retrieved VPN route and contains only the information to be updated.

This request updates a VPN route with the information in a provided VPN route patch. The VPN route patch object is structured in the same way as a retrieved VPN route and contains only the information to be updated.

This request updates a VPN route with the information in a provided VPN route patch. The VPN route patch object is structured in the same way as a retrieved VPN route and contains only the information to be updated.

PATCH /vpn_servers/{vpn_server_id}/routes/{id}
(vpc *VpcV1) UpdateVPNServerRoute(updateVPNServerRouteOptions *UpdateVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateVPNServerRouteWithContext(ctx context.Context, updateVPNServerRouteOptions *UpdateVPNServerRouteOptions) (result *VPNServerRoute, response *core.DetailedResponse, err error)
update_vpn_server_route(
        self,
        vpn_server_id: str,
        id: str,
        vpn_server_route_patch: 'VPNServerRoutePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<VPNServerRoute> updateVpnServerRoute(UpdateVpnServerRouteOptions updateVpnServerRouteOptions)
updateVpnServerRoute(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.vpn-server.vpn-server.update

Auditing

Calling this method generates the following auditing event.

  • is.vpn-server.vpn-server-route.update

List all load balancer profiles

This request lists all load balancer profiles available in the region. A load balancer profile specifies the performance characteristics and pricing model for a load balancer.

This request lists all load balancer profiles available in the region. A load balancer profile specifies the performance characteristics and pricing model for a load balancer.

This request lists all load balancer profiles available in the region. A load balancer profile specifies the performance characteristics and pricing model for a load balancer.

This request lists all load balancer profiles available in the region. A load balancer profile specifies the performance characteristics and pricing model for a load balancer.

This request lists all load balancer profiles available in the region. A load balancer profile specifies the performance characteristics and pricing model for a load balancer.

GET /load_balancer/profiles
(vpc *VpcV1) ListLoadBalancerProfiles(listLoadBalancerProfilesOptions *ListLoadBalancerProfilesOptions) (result *LoadBalancerProfileCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListLoadBalancerProfilesWithContext(ctx context.Context, listLoadBalancerProfilesOptions *ListLoadBalancerProfilesOptions) (result *LoadBalancerProfileCollection, response *core.DetailedResponse, err error)
list_load_balancer_profiles(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerProfileCollection> listLoadBalancerProfiles(ListLoadBalancerProfilesOptions listLoadBalancerProfilesOptions)
listLoadBalancerProfiles(params)

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-profile.read

Retrieve a load balancer profile

This request retrieves a load balancer profile specified by the name in the URL.

This request retrieves a load balancer profile specified by the name in the URL.

This request retrieves a load balancer profile specified by the name in the URL.

This request retrieves a load balancer profile specified by the name in the URL.

This request retrieves a load balancer profile specified by the name in the URL.

GET /load_balancer/profiles/{name}
(vpc *VpcV1) GetLoadBalancerProfile(getLoadBalancerProfileOptions *GetLoadBalancerProfileOptions) (result *LoadBalancerProfile, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetLoadBalancerProfileWithContext(ctx context.Context, getLoadBalancerProfileOptions *GetLoadBalancerProfileOptions) (result *LoadBalancerProfile, response *core.DetailedResponse, err error)
get_load_balancer_profile(
        self,
        name: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerProfile> getLoadBalancerProfile(GetLoadBalancerProfileOptions getLoadBalancerProfileOptions)
getLoadBalancerProfile(params)

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-profile.read

List all load balancers

This request lists all load balancers in the region.

This request lists all load balancers in the region.

This request lists all load balancers in the region.

This request lists all load balancers in the region.

This request lists all load balancers in the region.

GET /load_balancers
(vpc *VpcV1) ListLoadBalancers(listLoadBalancersOptions *ListLoadBalancersOptions) (result *LoadBalancerCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListLoadBalancersWithContext(ctx context.Context, listLoadBalancersOptions *ListLoadBalancersOptions) (result *LoadBalancerCollection, response *core.DetailedResponse, err error)
list_load_balancers(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerCollection> listLoadBalancers(ListLoadBalancersOptions listLoadBalancersOptions)
listLoadBalancers(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer.read

Create a load balancer

This request creates and provisions a new load balancer.

This request creates and provisions a new load balancer.

This request creates and provisions a new load balancer.

This request creates and provisions a new load balancer.

This request creates and provisions a new load balancer.

POST /load_balancers
(vpc *VpcV1) CreateLoadBalancer(createLoadBalancerOptions *CreateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateLoadBalancerWithContext(ctx context.Context, createLoadBalancerOptions *CreateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)
create_load_balancer(
        self,
        is_public: bool,
        subnets: List['SubnetIdentity'],
        *,
        dns: Optional['LoadBalancerDNSPrototype'] = None,
        listeners: Optional[List['LoadBalancerListenerPrototypeLoadBalancerContext']] = None,
        logging: Optional['LoadBalancerLoggingPrototype'] = None,
        name: Optional[str] = None,
        pools: Optional[List['LoadBalancerPoolPrototype']] = None,
        profile: Optional['LoadBalancerProfileIdentity'] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        route_mode: Optional[bool] = None,
        security_groups: Optional[List['SecurityGroupIdentity']] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancer> createLoadBalancer(CreateLoadBalancerOptions createLoadBalancerOptions)
createLoadBalancer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

  • is.security-group.security-group.operate

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer.create

Delete a load balancer

This request deletes a load balancer. This operation cannot be reversed. A load balancer cannot be deleted if its provisioning_status is delete_pending or it is referenced by a resource.

This request deletes a load balancer. This operation cannot be reversed. A load balancer cannot be deleted if its provisioning_status is delete_pending or it is referenced by a resource.

This request deletes a load balancer. This operation cannot be reversed. A load balancer cannot be deleted if its provisioning_status is delete_pending or it is referenced by a resource.

This request deletes a load balancer. This operation cannot be reversed. A load balancer cannot be deleted if its provisioning_status is delete_pending or it is referenced by a resource.

This request deletes a load balancer. This operation cannot be reversed. A load balancer cannot be deleted if its provisioning_status is delete_pending or it is referenced by a resource.

DELETE /load_balancers/{id}
(vpc *VpcV1) DeleteLoadBalancer(deleteLoadBalancerOptions *DeleteLoadBalancerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteLoadBalancerWithContext(ctx context.Context, deleteLoadBalancerOptions *DeleteLoadBalancerOptions) (response *core.DetailedResponse, err error)
delete_load_balancer(
        self,
        id: str,
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteLoadBalancer(DeleteLoadBalancerOptions deleteLoadBalancerOptions)
deleteLoadBalancer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer.delete

Retrieve a load balancer

This request retrieves a single load balancer specified by the identifier in the URL path.

This request retrieves a single load balancer specified by the identifier in the URL path.

This request retrieves a single load balancer specified by the identifier in the URL path.

This request retrieves a single load balancer specified by the identifier in the URL path.

This request retrieves a single load balancer specified by the identifier in the URL path.

GET /load_balancers/{id}
(vpc *VpcV1) GetLoadBalancer(getLoadBalancerOptions *GetLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetLoadBalancerWithContext(ctx context.Context, getLoadBalancerOptions *GetLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)
get_load_balancer(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancer> getLoadBalancer(GetLoadBalancerOptions getLoadBalancerOptions)
getLoadBalancer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer.read

Update a load balancer

This request updates a load balancer with the information in a provided load balancer patch. The load balancer patch object is structured in the same way as a retrieved load balancer and contains only the information to be updated. A load balancer can only be updated if its provisioning_status is active.

This request updates a load balancer with the information in a provided load balancer patch. The load balancer patch object is structured in the same way as a retrieved load balancer and contains only the information to be updated. A load balancer can only be updated if its provisioning_status is active.

This request updates a load balancer with the information in a provided load balancer patch. The load balancer patch object is structured in the same way as a retrieved load balancer and contains only the information to be updated. A load balancer can only be updated if its provisioning_status is active.

This request updates a load balancer with the information in a provided load balancer patch. The load balancer patch object is structured in the same way as a retrieved load balancer and contains only the information to be updated. A load balancer can only be updated if its provisioning_status is active.

This request updates a load balancer with the information in a provided load balancer patch. The load balancer patch object is structured in the same way as a retrieved load balancer and contains only the information to be updated. A load balancer can only be updated if its provisioning_status is active.

PATCH /load_balancers/{id}
(vpc *VpcV1) UpdateLoadBalancer(updateLoadBalancerOptions *UpdateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateLoadBalancerWithContext(ctx context.Context, updateLoadBalancerOptions *UpdateLoadBalancerOptions) (result *LoadBalancer, response *core.DetailedResponse, err error)
update_load_balancer(
        self,
        id: str,
        load_balancer_patch: 'LoadBalancerPatch',
        *,
        if_match: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancer> updateLoadBalancer(UpdateLoadBalancerOptions updateLoadBalancerOptions)
updateLoadBalancer(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer.update

List all statistics of a load balancer

This request lists statistics of a load balancer.

This request lists statistics of a load balancer.

This request lists statistics of a load balancer.

This request lists statistics of a load balancer.

This request lists statistics of a load balancer.

GET /load_balancers/{id}/statistics
(vpc *VpcV1) GetLoadBalancerStatistics(getLoadBalancerStatisticsOptions *GetLoadBalancerStatisticsOptions) (result *LoadBalancerStatistics, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetLoadBalancerStatisticsWithContext(ctx context.Context, getLoadBalancerStatisticsOptions *GetLoadBalancerStatisticsOptions) (result *LoadBalancerStatistics, response *core.DetailedResponse, err error)
get_load_balancer_statistics(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerStatistics> getLoadBalancerStatistics(GetLoadBalancerStatisticsOptions getLoadBalancerStatisticsOptions)
getLoadBalancerStatistics(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

List all listeners for a load balancer

This request lists all listeners for a load balancer.

This request lists all listeners for a load balancer.

This request lists all listeners for a load balancer.

This request lists all listeners for a load balancer.

This request lists all listeners for a load balancer.

GET /load_balancers/{load_balancer_id}/listeners
(vpc *VpcV1) ListLoadBalancerListeners(listLoadBalancerListenersOptions *ListLoadBalancerListenersOptions) (result *LoadBalancerListenerCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListLoadBalancerListenersWithContext(ctx context.Context, listLoadBalancerListenersOptions *ListLoadBalancerListenersOptions) (result *LoadBalancerListenerCollection, response *core.DetailedResponse, err error)
list_load_balancer_listeners(
        self,
        load_balancer_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerCollection> listLoadBalancerListeners(ListLoadBalancerListenersOptions listLoadBalancerListenersOptions)
listLoadBalancerListeners(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener.read

Create a listener for a load balancer

This request creates a new listener for a load balancer.

This request creates a new listener for a load balancer.

This request creates a new listener for a load balancer.

This request creates a new listener for a load balancer.

This request creates a new listener for a load balancer.

POST /load_balancers/{load_balancer_id}/listeners
(vpc *VpcV1) CreateLoadBalancerListener(createLoadBalancerListenerOptions *CreateLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateLoadBalancerListenerWithContext(ctx context.Context, createLoadBalancerListenerOptions *CreateLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error)
create_load_balancer_listener(
        self,
        load_balancer_id: str,
        protocol: str,
        *,
        accept_proxy_protocol: Optional[bool] = None,
        certificate_instance: Optional['CertificateInstanceIdentity'] = None,
        connection_limit: Optional[int] = None,
        default_pool: Optional['LoadBalancerPoolIdentity'] = None,
        https_redirect: Optional['LoadBalancerListenerHTTPSRedirectPrototype'] = None,
        idle_connection_timeout: Optional[int] = None,
        policies: Optional[List['LoadBalancerListenerPolicyPrototype']] = None,
        port: Optional[int] = None,
        port_max: Optional[int] = None,
        port_min: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListener> createLoadBalancerListener(CreateLoadBalancerListenerOptions createLoadBalancerListenerOptions)
createLoadBalancerListener(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener.create

Delete a load balancer listener

This request deletes a load balancer listener. This operation cannot be reversed. For this operation to succeed, the listener must not be the target of another load balancer listener.

This request deletes a load balancer listener. This operation cannot be reversed. For this operation to succeed, the listener must not be the target of another load balancer listener.

This request deletes a load balancer listener. This operation cannot be reversed. For this operation to succeed, the listener must not be the target of another load balancer listener.

This request deletes a load balancer listener. This operation cannot be reversed. For this operation to succeed, the listener must not be the target of another load balancer listener.

This request deletes a load balancer listener. This operation cannot be reversed. For this operation to succeed, the listener must not be the target of another load balancer listener.

DELETE /load_balancers/{load_balancer_id}/listeners/{id}
(vpc *VpcV1) DeleteLoadBalancerListener(deleteLoadBalancerListenerOptions *DeleteLoadBalancerListenerOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteLoadBalancerListenerWithContext(ctx context.Context, deleteLoadBalancerListenerOptions *DeleteLoadBalancerListenerOptions) (response *core.DetailedResponse, err error)
delete_load_balancer_listener(
        self,
        load_balancer_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteLoadBalancerListener(DeleteLoadBalancerListenerOptions deleteLoadBalancerListenerOptions)
deleteLoadBalancerListener(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener.delete

Retrieve a load balancer listener

This request retrieves a single listener specified by the identifier in the URL path.

This request retrieves a single listener specified by the identifier in the URL path.

This request retrieves a single listener specified by the identifier in the URL path.

This request retrieves a single listener specified by the identifier in the URL path.

This request retrieves a single listener specified by the identifier in the URL path.

GET /load_balancers/{load_balancer_id}/listeners/{id}
(vpc *VpcV1) GetLoadBalancerListener(getLoadBalancerListenerOptions *GetLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetLoadBalancerListenerWithContext(ctx context.Context, getLoadBalancerListenerOptions *GetLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error)
get_load_balancer_listener(
        self,
        load_balancer_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListener> getLoadBalancerListener(GetLoadBalancerListenerOptions getLoadBalancerListenerOptions)
getLoadBalancerListener(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener.read

Update a load balancer listener

This request updates a load balancer listener from a listener patch.

This request updates a load balancer listener from a listener patch.

This request updates a load balancer listener from a listener patch.

This request updates a load balancer listener from a listener patch.

This request updates a load balancer listener from a listener patch.

PATCH /load_balancers/{load_balancer_id}/listeners/{id}
(vpc *VpcV1) UpdateLoadBalancerListener(updateLoadBalancerListenerOptions *UpdateLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateLoadBalancerListenerWithContext(ctx context.Context, updateLoadBalancerListenerOptions *UpdateLoadBalancerListenerOptions) (result *LoadBalancerListener, response *core.DetailedResponse, err error)
update_load_balancer_listener(
        self,
        load_balancer_id: str,
        id: str,
        load_balancer_listener_patch: 'LoadBalancerListenerPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListener> updateLoadBalancerListener(UpdateLoadBalancerListenerOptions updateLoadBalancerListenerOptions)
updateLoadBalancerListener(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener.update

List all policies for a load balancer listener

This request lists all policies for a load balancer listener. A policy consists of rules to match against each incoming request, and an action to apply to the request if a rule matches.

This request lists all policies for a load balancer listener. A policy consists of rules to match against each incoming request, and an action to apply to the request if a rule matches.

This request lists all policies for a load balancer listener. A policy consists of rules to match against each incoming request, and an action to apply to the request if a rule matches.

This request lists all policies for a load balancer listener. A policy consists of rules to match against each incoming request, and an action to apply to the request if a rule matches.

This request lists all policies for a load balancer listener. A policy consists of rules to match against each incoming request, and an action to apply to the request if a rule matches.

GET /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies
(vpc *VpcV1) ListLoadBalancerListenerPolicies(listLoadBalancerListenerPoliciesOptions *ListLoadBalancerListenerPoliciesOptions) (result *LoadBalancerListenerPolicyCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListLoadBalancerListenerPoliciesWithContext(ctx context.Context, listLoadBalancerListenerPoliciesOptions *ListLoadBalancerListenerPoliciesOptions) (result *LoadBalancerListenerPolicyCollection, response *core.DetailedResponse, err error)
list_load_balancer_listener_policies(
        self,
        load_balancer_id: str,
        listener_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerPolicyCollection> listLoadBalancerListenerPolicies(ListLoadBalancerListenerPoliciesOptions listLoadBalancerListenerPoliciesOptions)
listLoadBalancerListenerPolicies(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy.read

Create a policy for a load balancer listener

This request creates a new policy from a load balancer listener policy object. The prototype object is structured in the same way as a retrieved policy, and contains the information necessary to create the new policy. For this request to succeed, the listener must have a protocol of http or https.

This request creates a new policy from a load balancer listener policy object. The prototype object is structured in the same way as a retrieved policy, and contains the information necessary to create the new policy. For this request to succeed, the listener must have a protocol of http or https.

This request creates a new policy from a load balancer listener policy object. The prototype object is structured in the same way as a retrieved policy, and contains the information necessary to create the new policy. For this request to succeed, the listener must have a protocol of http or https.

This request creates a new policy from a load balancer listener policy object. The prototype object is structured in the same way as a retrieved policy, and contains the information necessary to create the new policy. For this request to succeed, the listener must have a protocol of http or https.

This request creates a new policy from a load balancer listener policy object. The prototype object is structured in the same way as a retrieved policy, and contains the information necessary to create the new policy. For this request to succeed, the listener must have a protocol of http or https.

POST /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies
(vpc *VpcV1) CreateLoadBalancerListenerPolicy(createLoadBalancerListenerPolicyOptions *CreateLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateLoadBalancerListenerPolicyWithContext(ctx context.Context, createLoadBalancerListenerPolicyOptions *CreateLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error)
create_load_balancer_listener_policy(
        self,
        load_balancer_id: str,
        listener_id: str,
        action: str,
        priority: int,
        *,
        name: Optional[str] = None,
        rules: Optional[List['LoadBalancerListenerPolicyRulePrototype']] = None,
        target: Optional['LoadBalancerListenerPolicyTargetPrototype'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerPolicy> createLoadBalancerListenerPolicy(CreateLoadBalancerListenerPolicyOptions createLoadBalancerListenerPolicyOptions)
createLoadBalancerListenerPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy.create

Delete a load balancer listener policy

Deletes a policy of the load balancer listener. This operation cannot be reversed.

Deletes a policy of the load balancer listener. This operation cannot be reversed.

Deletes a policy of the load balancer listener. This operation cannot be reversed.

Deletes a policy of the load balancer listener. This operation cannot be reversed.

Deletes a policy of the load balancer listener. This operation cannot be reversed.

DELETE /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{id}
(vpc *VpcV1) DeleteLoadBalancerListenerPolicy(deleteLoadBalancerListenerPolicyOptions *DeleteLoadBalancerListenerPolicyOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteLoadBalancerListenerPolicyWithContext(ctx context.Context, deleteLoadBalancerListenerPolicyOptions *DeleteLoadBalancerListenerPolicyOptions) (response *core.DetailedResponse, err error)
delete_load_balancer_listener_policy(
        self,
        load_balancer_id: str,
        listener_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteLoadBalancerListenerPolicy(DeleteLoadBalancerListenerPolicyOptions deleteLoadBalancerListenerPolicyOptions)
deleteLoadBalancerListenerPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy.delete

Retrieve a load balancer listener policy

Retrieve a single policy specified by the identifier in the URL path.

Retrieve a single policy specified by the identifier in the URL path.

Retrieve a single policy specified by the identifier in the URL path.

Retrieve a single policy specified by the identifier in the URL path.

Retrieve a single policy specified by the identifier in the URL path.

GET /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{id}
(vpc *VpcV1) GetLoadBalancerListenerPolicy(getLoadBalancerListenerPolicyOptions *GetLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetLoadBalancerListenerPolicyWithContext(ctx context.Context, getLoadBalancerListenerPolicyOptions *GetLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error)
get_load_balancer_listener_policy(
        self,
        load_balancer_id: str,
        listener_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerPolicy> getLoadBalancerListenerPolicy(GetLoadBalancerListenerPolicyOptions getLoadBalancerListenerPolicyOptions)
getLoadBalancerListenerPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy.read

Update a load balancer listener policy

This request updates a load balancer listener policy with the information in a provided policy patch. The policy patch object is structured in the same way as a retrieved policy and contains only the information to be updated.

This request updates a load balancer listener policy with the information in a provided policy patch. The policy patch object is structured in the same way as a retrieved policy and contains only the information to be updated.

This request updates a load balancer listener policy with the information in a provided policy patch. The policy patch object is structured in the same way as a retrieved policy and contains only the information to be updated.

This request updates a load balancer listener policy with the information in a provided policy patch. The policy patch object is structured in the same way as a retrieved policy and contains only the information to be updated.

This request updates a load balancer listener policy with the information in a provided policy patch. The policy patch object is structured in the same way as a retrieved policy and contains only the information to be updated.

PATCH /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{id}
(vpc *VpcV1) UpdateLoadBalancerListenerPolicy(updateLoadBalancerListenerPolicyOptions *UpdateLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateLoadBalancerListenerPolicyWithContext(ctx context.Context, updateLoadBalancerListenerPolicyOptions *UpdateLoadBalancerListenerPolicyOptions) (result *LoadBalancerListenerPolicy, response *core.DetailedResponse, err error)
update_load_balancer_listener_policy(
        self,
        load_balancer_id: str,
        listener_id: str,
        id: str,
        load_balancer_listener_policy_patch: 'LoadBalancerListenerPolicyPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerPolicy> updateLoadBalancerListenerPolicy(UpdateLoadBalancerListenerPolicyOptions updateLoadBalancerListenerPolicyOptions)
updateLoadBalancerListenerPolicy(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy.update

List all rules of a load balancer listener policy

This request lists all rules of a load balancer listener policy.

This request lists all rules of a load balancer listener policy.

This request lists all rules of a load balancer listener policy.

This request lists all rules of a load balancer listener policy.

This request lists all rules of a load balancer listener policy.

GET /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules
(vpc *VpcV1) ListLoadBalancerListenerPolicyRules(listLoadBalancerListenerPolicyRulesOptions *ListLoadBalancerListenerPolicyRulesOptions) (result *LoadBalancerListenerPolicyRuleCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListLoadBalancerListenerPolicyRulesWithContext(ctx context.Context, listLoadBalancerListenerPolicyRulesOptions *ListLoadBalancerListenerPolicyRulesOptions) (result *LoadBalancerListenerPolicyRuleCollection, response *core.DetailedResponse, err error)
list_load_balancer_listener_policy_rules(
        self,
        load_balancer_id: str,
        listener_id: str,
        policy_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerPolicyRuleCollection> listLoadBalancerListenerPolicyRules(ListLoadBalancerListenerPolicyRulesOptions listLoadBalancerListenerPolicyRulesOptions)
listLoadBalancerListenerPolicyRules(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy-rule.read

Create a rule for a load balancer listener policy

Creates a new rule for the load balancer listener policy.

Creates a new rule for the load balancer listener policy.

Creates a new rule for the load balancer listener policy.

Creates a new rule for the load balancer listener policy.

Creates a new rule for the load balancer listener policy.

POST /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules
(vpc *VpcV1) CreateLoadBalancerListenerPolicyRule(createLoadBalancerListenerPolicyRuleOptions *CreateLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateLoadBalancerListenerPolicyRuleWithContext(ctx context.Context, createLoadBalancerListenerPolicyRuleOptions *CreateLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error)
create_load_balancer_listener_policy_rule(
        self,
        load_balancer_id: str,
        listener_id: str,
        policy_id: str,
        condition: str,
        type: str,
        value: str,
        *,
        field: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerPolicyRule> createLoadBalancerListenerPolicyRule(CreateLoadBalancerListenerPolicyRuleOptions createLoadBalancerListenerPolicyRuleOptions)
createLoadBalancerListenerPolicyRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy-rule.create

Delete a load balancer listener policy rule

Deletes a rule from the load balancer listener policy. This operation cannot be reversed.

Deletes a rule from the load balancer listener policy. This operation cannot be reversed.

Deletes a rule from the load balancer listener policy. This operation cannot be reversed.

Deletes a rule from the load balancer listener policy. This operation cannot be reversed.

Deletes a rule from the load balancer listener policy. This operation cannot be reversed.

DELETE /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules/{id}
(vpc *VpcV1) DeleteLoadBalancerListenerPolicyRule(deleteLoadBalancerListenerPolicyRuleOptions *DeleteLoadBalancerListenerPolicyRuleOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteLoadBalancerListenerPolicyRuleWithContext(ctx context.Context, deleteLoadBalancerListenerPolicyRuleOptions *DeleteLoadBalancerListenerPolicyRuleOptions) (response *core.DetailedResponse, err error)
delete_load_balancer_listener_policy_rule(
        self,
        load_balancer_id: str,
        listener_id: str,
        policy_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteLoadBalancerListenerPolicyRule(DeleteLoadBalancerListenerPolicyRuleOptions deleteLoadBalancerListenerPolicyRuleOptions)
deleteLoadBalancerListenerPolicyRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy-rule.delete

Retrieve a load balancer listener policy rule

Retrieves a single rule specified by the identifier in the URL path.

Retrieves a single rule specified by the identifier in the URL path.

Retrieves a single rule specified by the identifier in the URL path.

Retrieves a single rule specified by the identifier in the URL path.

Retrieves a single rule specified by the identifier in the URL path.

GET /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules/{id}
(vpc *VpcV1) GetLoadBalancerListenerPolicyRule(getLoadBalancerListenerPolicyRuleOptions *GetLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetLoadBalancerListenerPolicyRuleWithContext(ctx context.Context, getLoadBalancerListenerPolicyRuleOptions *GetLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error)
get_load_balancer_listener_policy_rule(
        self,
        load_balancer_id: str,
        listener_id: str,
        policy_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerPolicyRule> getLoadBalancerListenerPolicyRule(GetLoadBalancerListenerPolicyRuleOptions getLoadBalancerListenerPolicyRuleOptions)
getLoadBalancerListenerPolicyRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy-rule.read

Update a load balancer listener policy rule

Updates a rule of the load balancer listener policy.

Updates a rule of the load balancer listener policy.

Updates a rule of the load balancer listener policy.

Updates a rule of the load balancer listener policy.

Updates a rule of the load balancer listener policy.

PATCH /load_balancers/{load_balancer_id}/listeners/{listener_id}/policies/{policy_id}/rules/{id}
(vpc *VpcV1) UpdateLoadBalancerListenerPolicyRule(updateLoadBalancerListenerPolicyRuleOptions *UpdateLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateLoadBalancerListenerPolicyRuleWithContext(ctx context.Context, updateLoadBalancerListenerPolicyRuleOptions *UpdateLoadBalancerListenerPolicyRuleOptions) (result *LoadBalancerListenerPolicyRule, response *core.DetailedResponse, err error)
update_load_balancer_listener_policy_rule(
        self,
        load_balancer_id: str,
        listener_id: str,
        policy_id: str,
        id: str,
        load_balancer_listener_policy_rule_patch: 'LoadBalancerListenerPolicyRulePatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerListenerPolicyRule> updateLoadBalancerListenerPolicyRule(UpdateLoadBalancerListenerPolicyRuleOptions updateLoadBalancerListenerPolicyRuleOptions)
updateLoadBalancerListenerPolicyRule(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-listener-policy-rule.update

List all pools of a load balancer

This request lists all pools of a load balancer.

This request lists all pools of a load balancer.

This request lists all pools of a load balancer.

This request lists all pools of a load balancer.

This request lists all pools of a load balancer.

GET /load_balancers/{load_balancer_id}/pools
(vpc *VpcV1) ListLoadBalancerPools(listLoadBalancerPoolsOptions *ListLoadBalancerPoolsOptions) (result *LoadBalancerPoolCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListLoadBalancerPoolsWithContext(ctx context.Context, listLoadBalancerPoolsOptions *ListLoadBalancerPoolsOptions) (result *LoadBalancerPoolCollection, response *core.DetailedResponse, err error)
list_load_balancer_pools(
        self,
        load_balancer_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPoolCollection> listLoadBalancerPools(ListLoadBalancerPoolsOptions listLoadBalancerPoolsOptions)
listLoadBalancerPools(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool.read

Create a load balancer pool

This request creates a new pool from a pool prototype object.

This request creates a new pool from a pool prototype object.

This request creates a new pool from a pool prototype object.

This request creates a new pool from a pool prototype object.

This request creates a new pool from a pool prototype object.

POST /load_balancers/{load_balancer_id}/pools
(vpc *VpcV1) CreateLoadBalancerPool(createLoadBalancerPoolOptions *CreateLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateLoadBalancerPoolWithContext(ctx context.Context, createLoadBalancerPoolOptions *CreateLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error)
create_load_balancer_pool(
        self,
        load_balancer_id: str,
        algorithm: str,
        health_monitor: 'LoadBalancerPoolHealthMonitorPrototype',
        protocol: str,
        *,
        members: Optional[List['LoadBalancerPoolMemberPrototype']] = None,
        name: Optional[str] = None,
        proxy_protocol: Optional[str] = None,
        session_persistence: Optional['LoadBalancerPoolSessionPersistencePrototype'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPool> createLoadBalancerPool(CreateLoadBalancerPoolOptions createLoadBalancerPoolOptions)
createLoadBalancerPool(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool.create

Delete a load balancer pool

This request deletes a load balancer pool. This operation cannot be reversed. The pool must not currently be the default pool for any listener in the load balancer.

This request deletes a load balancer pool. This operation cannot be reversed. The pool must not currently be the default pool for any listener in the load balancer.

This request deletes a load balancer pool. This operation cannot be reversed. The pool must not currently be the default pool for any listener in the load balancer.

This request deletes a load balancer pool. This operation cannot be reversed. The pool must not currently be the default pool for any listener in the load balancer.

This request deletes a load balancer pool. This operation cannot be reversed. The pool must not currently be the default pool for any listener in the load balancer.

DELETE /load_balancers/{load_balancer_id}/pools/{id}
(vpc *VpcV1) DeleteLoadBalancerPool(deleteLoadBalancerPoolOptions *DeleteLoadBalancerPoolOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteLoadBalancerPoolWithContext(ctx context.Context, deleteLoadBalancerPoolOptions *DeleteLoadBalancerPoolOptions) (response *core.DetailedResponse, err error)
delete_load_balancer_pool(
        self,
        load_balancer_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteLoadBalancerPool(DeleteLoadBalancerPoolOptions deleteLoadBalancerPoolOptions)
deleteLoadBalancerPool(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool.delete

Retrieve a load balancer pool

This request retrieves a single pool specified by the identifier in the URL path.

This request retrieves a single pool specified by the identifier in the URL path.

This request retrieves a single pool specified by the identifier in the URL path.

This request retrieves a single pool specified by the identifier in the URL path.

This request retrieves a single pool specified by the identifier in the URL path.

GET /load_balancers/{load_balancer_id}/pools/{id}
(vpc *VpcV1) GetLoadBalancerPool(getLoadBalancerPoolOptions *GetLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetLoadBalancerPoolWithContext(ctx context.Context, getLoadBalancerPoolOptions *GetLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error)
get_load_balancer_pool(
        self,
        load_balancer_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPool> getLoadBalancerPool(GetLoadBalancerPoolOptions getLoadBalancerPoolOptions)
getLoadBalancerPool(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool.read

Update a load balancer pool

This request updates a load balancer pool from a pool patch.

This request updates a load balancer pool from a pool patch.

This request updates a load balancer pool from a pool patch.

This request updates a load balancer pool from a pool patch.

This request updates a load balancer pool from a pool patch.

PATCH /load_balancers/{load_balancer_id}/pools/{id}
(vpc *VpcV1) UpdateLoadBalancerPool(updateLoadBalancerPoolOptions *UpdateLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateLoadBalancerPoolWithContext(ctx context.Context, updateLoadBalancerPoolOptions *UpdateLoadBalancerPoolOptions) (result *LoadBalancerPool, response *core.DetailedResponse, err error)
update_load_balancer_pool(
        self,
        load_balancer_id: str,
        id: str,
        load_balancer_pool_patch: 'LoadBalancerPoolPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPool> updateLoadBalancerPool(UpdateLoadBalancerPoolOptions updateLoadBalancerPoolOptions)
updateLoadBalancerPool(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool.update

List all members of a load balancer pool

This request lists all members of a load balancer pool.

This request lists all members of a load balancer pool.

This request lists all members of a load balancer pool.

This request lists all members of a load balancer pool.

This request lists all members of a load balancer pool.

GET /load_balancers/{load_balancer_id}/pools/{pool_id}/members
(vpc *VpcV1) ListLoadBalancerPoolMembers(listLoadBalancerPoolMembersOptions *ListLoadBalancerPoolMembersOptions) (result *LoadBalancerPoolMemberCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListLoadBalancerPoolMembersWithContext(ctx context.Context, listLoadBalancerPoolMembersOptions *ListLoadBalancerPoolMembersOptions) (result *LoadBalancerPoolMemberCollection, response *core.DetailedResponse, err error)
list_load_balancer_pool_members(
        self,
        load_balancer_id: str,
        pool_id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPoolMemberCollection> listLoadBalancerPoolMembers(ListLoadBalancerPoolMembersOptions listLoadBalancerPoolMembersOptions)
listLoadBalancerPoolMembers(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool-member.read

Create a member in a load balancer pool

This request creates a new member and adds the member to the pool.

This request creates a new member and adds the member to the pool.

This request creates a new member and adds the member to the pool.

This request creates a new member and adds the member to the pool.

This request creates a new member and adds the member to the pool.

POST /load_balancers/{load_balancer_id}/pools/{pool_id}/members
(vpc *VpcV1) CreateLoadBalancerPoolMember(createLoadBalancerPoolMemberOptions *CreateLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateLoadBalancerPoolMemberWithContext(ctx context.Context, createLoadBalancerPoolMemberOptions *CreateLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error)
create_load_balancer_pool_member(
        self,
        load_balancer_id: str,
        pool_id: str,
        port: int,
        target: 'LoadBalancerPoolMemberTargetPrototype',
        *,
        weight: Optional[int] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPoolMember> createLoadBalancerPoolMember(CreateLoadBalancerPoolMemberOptions createLoadBalancerPoolMemberOptions)
createLoadBalancerPoolMember(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool-member.create

Replace load balancer pool members

This request replaces the existing members of the load balancer pool with new members created from the collection of member prototype objects.

This request replaces the existing members of the load balancer pool with new members created from the collection of member prototype objects.

This request replaces the existing members of the load balancer pool with new members created from the collection of member prototype objects.

This request replaces the existing members of the load balancer pool with new members created from the collection of member prototype objects.

This request replaces the existing members of the load balancer pool with new members created from the collection of member prototype objects.

PUT /load_balancers/{load_balancer_id}/pools/{pool_id}/members
(vpc *VpcV1) ReplaceLoadBalancerPoolMembers(replaceLoadBalancerPoolMembersOptions *ReplaceLoadBalancerPoolMembersOptions) (result *LoadBalancerPoolMemberCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ReplaceLoadBalancerPoolMembersWithContext(ctx context.Context, replaceLoadBalancerPoolMembersOptions *ReplaceLoadBalancerPoolMembersOptions) (result *LoadBalancerPoolMemberCollection, response *core.DetailedResponse, err error)
replace_load_balancer_pool_members(
        self,
        load_balancer_id: str,
        pool_id: str,
        members: List['LoadBalancerPoolMemberPrototype'],
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPoolMemberCollection> replaceLoadBalancerPoolMembers(ReplaceLoadBalancerPoolMembersOptions replaceLoadBalancerPoolMembersOptions)
replaceLoadBalancerPoolMembers(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Delete a load balancer pool member

This request deletes a member from the pool. This operation cannot be reversed.

This request deletes a member from the pool. This operation cannot be reversed.

This request deletes a member from the pool. This operation cannot be reversed.

This request deletes a member from the pool. This operation cannot be reversed.

This request deletes a member from the pool. This operation cannot be reversed.

DELETE /load_balancers/{load_balancer_id}/pools/{pool_id}/members/{id}
(vpc *VpcV1) DeleteLoadBalancerPoolMember(deleteLoadBalancerPoolMemberOptions *DeleteLoadBalancerPoolMemberOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteLoadBalancerPoolMemberWithContext(ctx context.Context, deleteLoadBalancerPoolMemberOptions *DeleteLoadBalancerPoolMemberOptions) (response *core.DetailedResponse, err error)
delete_load_balancer_pool_member(
        self,
        load_balancer_id: str,
        pool_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteLoadBalancerPoolMember(DeleteLoadBalancerPoolMemberOptions deleteLoadBalancerPoolMemberOptions)
deleteLoadBalancerPoolMember(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool-member.delete

Retrieve a load balancer pool member

This request retrieves a single member specified by the identifier in the URL path.

This request retrieves a single member specified by the identifier in the URL path.

This request retrieves a single member specified by the identifier in the URL path.

This request retrieves a single member specified by the identifier in the URL path.

This request retrieves a single member specified by the identifier in the URL path.

GET /load_balancers/{load_balancer_id}/pools/{pool_id}/members/{id}
(vpc *VpcV1) GetLoadBalancerPoolMember(getLoadBalancerPoolMemberOptions *GetLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetLoadBalancerPoolMemberWithContext(ctx context.Context, getLoadBalancerPoolMemberOptions *GetLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error)
get_load_balancer_pool_member(
        self,
        load_balancer_id: str,
        pool_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPoolMember> getLoadBalancerPoolMember(GetLoadBalancerPoolMemberOptions getLoadBalancerPoolMemberOptions)
getLoadBalancerPoolMember(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.view

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool-member.read

Update a load balancer pool member

This request updates an existing member from a member patch.

This request updates an existing member from a member patch.

This request updates an existing member from a member patch.

This request updates an existing member from a member patch.

This request updates an existing member from a member patch.

PATCH /load_balancers/{load_balancer_id}/pools/{pool_id}/members/{id}
(vpc *VpcV1) UpdateLoadBalancerPoolMember(updateLoadBalancerPoolMemberOptions *UpdateLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateLoadBalancerPoolMemberWithContext(ctx context.Context, updateLoadBalancerPoolMemberOptions *UpdateLoadBalancerPoolMemberOptions) (result *LoadBalancerPoolMember, response *core.DetailedResponse, err error)
update_load_balancer_pool_member(
        self,
        load_balancer_id: str,
        pool_id: str,
        id: str,
        load_balancer_pool_member_patch: 'LoadBalancerPoolMemberPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<LoadBalancerPoolMember> updateLoadBalancerPoolMember(UpdateLoadBalancerPoolMemberOptions updateLoadBalancerPoolMemberOptions)
updateLoadBalancerPoolMember(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.load-balancer.load-balancer.manage

Auditing

Calling this method generates the following auditing event.

  • is.load-balancer.load-balancer-pool-member.update

List all endpoint gateways

This request lists all endpoint gateways in the region. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

This request lists all endpoint gateways in the region. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

This request lists all endpoint gateways in the region. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

This request lists all endpoint gateways in the region. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

This request lists all endpoint gateways in the region. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

GET /endpoint_gateways
(vpc *VpcV1) ListEndpointGateways(listEndpointGatewaysOptions *ListEndpointGatewaysOptions) (result *EndpointGatewayCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListEndpointGatewaysWithContext(ctx context.Context, listEndpointGatewaysOptions *ListEndpointGatewaysOptions) (result *EndpointGatewayCollection, response *core.DetailedResponse, err error)
list_endpoint_gateways(
        self,
        *,
        name: Optional[str] = None,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_crn: Optional[str] = None,
        vpc_name: Optional[str] = None,
        allow_dns_resolution_binding: Optional[bool] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<EndpointGatewayCollection> listEndpointGateways(ListEndpointGatewaysOptions listEndpointGatewaysOptions)
listEndpointGateways(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.endpoint-gateway.endpoint-gateway.list

  • is.endpoint-gateway.endpoint-gateway.read

Auditing

Calling this method generates the following auditing event.

  • is.endpoint-gateway.endpoint-gateway.list

Create an endpoint gateway

This request creates a new endpoint gateway. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

This request creates a new endpoint gateway. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

This request creates a new endpoint gateway. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

This request creates a new endpoint gateway. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

This request creates a new endpoint gateway. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.

POST /endpoint_gateways
(vpc *VpcV1) CreateEndpointGateway(createEndpointGatewayOptions *CreateEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateEndpointGatewayWithContext(ctx context.Context, createEndpointGatewayOptions *CreateEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error)
create_endpoint_gateway(
        self,
        target: 'EndpointGatewayTargetPrototype',
        vpc: 'VPCIdentity',
        *,
        allow_dns_resolution_binding: Optional[bool] = None,
        ips: Optional[List['EndpointGatewayReservedIP']] = None,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        security_groups: Optional[List['SecurityGroupIdentity']] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<EndpointGateway> createEndpointGateway(CreateEndpointGatewayOptions createEndpointGatewayOptions)
createEndpointGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.endpoint-gateway.endpoint-gateway.create

  • is.vpc.vpc.operate

  • is.subnet.subnet.update

    Required for any subnet on which ips specifies one or more new reserved IPs

  • is.subnet.subnet.operate

    Required for any subnet on which ips specifies one or more existing reserved IPs

  • is.security-group.security-group.operate

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.endpoint-gateway.endpoint-gateway.create

  • is.endpoint-gateway.endpoint-gateway.attach

    Generated for each resource being attached to the endpoint gateway (such as a security group).

  • is.subnet.reserved-ip.create

    Generated for each reserved IP created that was specified in ips

  • is.subnet.reserved-ip.attach

    Generated for each reserved IP that was specified in ips.

  • is.security-group.security-group.attach

    Generated for each security group that was specified in security_groups.

List all reserved IPs bound to an endpoint gateway

This request lists all reserved IPs bound to an endpoint gateway.

This request lists all reserved IPs bound to an endpoint gateway.

This request lists all reserved IPs bound to an endpoint gateway.

This request lists all reserved IPs bound to an endpoint gateway.

This request lists all reserved IPs bound to an endpoint gateway.

GET /endpoint_gateways/{endpoint_gateway_id}/ips
(vpc *VpcV1) ListEndpointGatewayIps(listEndpointGatewayIpsOptions *ListEndpointGatewayIpsOptions) (result *ReservedIPCollectionEndpointGatewayContext, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListEndpointGatewayIpsWithContext(ctx context.Context, listEndpointGatewayIpsOptions *ListEndpointGatewayIpsOptions) (result *ReservedIPCollectionEndpointGatewayContext, response *core.DetailedResponse, err error)
list_endpoint_gateway_ips(
        self,
        endpoint_gateway_id: str,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        sort: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIPCollectionEndpointGatewayContext> listEndpointGatewayIps(ListEndpointGatewayIpsOptions listEndpointGatewayIpsOptions)
listEndpointGatewayIps(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.read

    Required for any subnet that has reserved IPs bound to this endpoint gateway. (Otherwise, those reserved IPs will be omitted.)

Auditing

Calling this method generates the following auditing event, depending on any listed conditions.

  • is.subnet.reserved-ip.read

    Generated for each reserved IP in the list

Unbind a reserved IP from an endpoint gateway

This request unbinds the specified reserved IP from the specified endpoint gateway. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

This request unbinds the specified reserved IP from the specified endpoint gateway. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

This request unbinds the specified reserved IP from the specified endpoint gateway. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

This request unbinds the specified reserved IP from the specified endpoint gateway. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

This request unbinds the specified reserved IP from the specified endpoint gateway. If the reserved IP has auto_delete set to true, the reserved IP will be deleted.

DELETE /endpoint_gateways/{endpoint_gateway_id}/ips/{id}
(vpc *VpcV1) RemoveEndpointGatewayIP(removeEndpointGatewayIPOptions *RemoveEndpointGatewayIPOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) RemoveEndpointGatewayIPWithContext(ctx context.Context, removeEndpointGatewayIPOptions *RemoveEndpointGatewayIPOptions) (response *core.DetailedResponse, err error)
remove_endpoint_gateway_ip(
        self,
        endpoint_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> removeEndpointGatewayIp(RemoveEndpointGatewayIpOptions removeEndpointGatewayIpOptions)
removeEndpointGatewayIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.endpoint-gateway.endpoint-gateway.operate

  • is.subnet.subnet.operate

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.endpoint-gateway.endpoint-gateway.detach

  • is.subnet.reserved-ip.detach

  • is.subnet.reserved-ip.delete

    Generated when the reserved IP has auto_delete set to true

Retrieve a reserved IP bound to an endpoint gateway

This request retrieves the specified reserved IP address if it is bound to the endpoint gateway specified in the URL.

This request retrieves the specified reserved IP address if it is bound to the endpoint gateway specified in the URL.

This request retrieves the specified reserved IP address if it is bound to the endpoint gateway specified in the URL.

This request retrieves the specified reserved IP address if it is bound to the endpoint gateway specified in the URL.

This request retrieves the specified reserved IP address if it is bound to the endpoint gateway specified in the URL.

GET /endpoint_gateways/{endpoint_gateway_id}/ips/{id}
(vpc *VpcV1) GetEndpointGatewayIP(getEndpointGatewayIPOptions *GetEndpointGatewayIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetEndpointGatewayIPWithContext(ctx context.Context, getEndpointGatewayIPOptions *GetEndpointGatewayIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
get_endpoint_gateway_ip(
        self,
        endpoint_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIP> getEndpointGatewayIp(GetEndpointGatewayIpOptions getEndpointGatewayIpOptions)
getEndpointGatewayIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.subnet.subnet.read

Auditing

Calling this method generates the following auditing event.

  • is.subnet.reserved-ip.read

Bind a reserved IP to an endpoint gateway

This request binds the specified reserved IP to the specified endpoint gateway. The reserved IP:

  • must currently be unbound, or not required by its target
  • must not be in the same zone as any other reserved IP bound to the endpoint gateway

This request binds the specified reserved IP to the specified endpoint gateway. The reserved IP:

  • must currently be unbound, or not required by its target
  • must not be in the same zone as any other reserved IP bound to the endpoint gateway.

This request binds the specified reserved IP to the specified endpoint gateway. The reserved IP:

  • must currently be unbound, or not required by its target
  • must not be in the same zone as any other reserved IP bound to the endpoint gateway.

This request binds the specified reserved IP to the specified endpoint gateway. The reserved IP:

  • must currently be unbound, or not required by its target
  • must not be in the same zone as any other reserved IP bound to the endpoint gateway.

This request binds the specified reserved IP to the specified endpoint gateway. The reserved IP:

  • must currently be unbound, or not required by its target
  • must not be in the same zone as any other reserved IP bound to the endpoint gateway.
PUT /endpoint_gateways/{endpoint_gateway_id}/ips/{id}
(vpc *VpcV1) AddEndpointGatewayIP(addEndpointGatewayIPOptions *AddEndpointGatewayIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
(vpc *VpcV1) AddEndpointGatewayIPWithContext(ctx context.Context, addEndpointGatewayIPOptions *AddEndpointGatewayIPOptions) (result *ReservedIP, response *core.DetailedResponse, err error)
add_endpoint_gateway_ip(
        self,
        endpoint_gateway_id: str,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<ReservedIP> addEndpointGatewayIp(AddEndpointGatewayIpOptions addEndpointGatewayIpOptions)
addEndpointGatewayIp(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions. You can check your access by going to Users > User > Access.

  • is.endpoint-gateway.endpoint-gateway.operate

  • is.subnet.subnet.operate

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.endpoint-gateway.endpoint-gateway.attach

    Generated when a reserved IP is attached to this endpoint gateway

  • is.subnet.reserved-ip.attach

    Generated when a reserved IP is attached to this endpoint gateway

Delete an endpoint gateway

This request deletes an endpoint gateway. This operation cannot be reversed.

Reserved IPs that were bound to the endpoint gateway will be released if their auto_delete property is set to true.

This request deletes an endpoint gateway. This operation cannot be reversed.

Reserved IPs that were bound to the endpoint gateway will be released if their auto_delete property is set to true.

This request deletes an endpoint gateway. This operation cannot be reversed.

Reserved IPs that were bound to the endpoint gateway will be released if their auto_delete property is set to true.

This request deletes an endpoint gateway. This operation cannot be reversed.

Reserved IPs that were bound to the endpoint gateway will be released if their auto_delete property is set to true.

This request deletes an endpoint gateway. This operation cannot be reversed.

Reserved IPs that were bound to the endpoint gateway will be released if their auto_delete property is set to true.

DELETE /endpoint_gateways/{id}
(vpc *VpcV1) DeleteEndpointGateway(deleteEndpointGatewayOptions *DeleteEndpointGatewayOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteEndpointGatewayWithContext(ctx context.Context, deleteEndpointGatewayOptions *DeleteEndpointGatewayOptions) (response *core.DetailedResponse, err error)
delete_endpoint_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteEndpointGateway(DeleteEndpointGatewayOptions deleteEndpointGatewayOptions)
deleteEndpointGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.endpoint-gateway.endpoint-gateway.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.endpoint-gateway.endpoint-gateway.delete

  • is.subnet.reserved-ip.detach

    Generated for each reserved IP in ips.

  • is.endpoint-gateway.endpoint-gateway.detach

    Generated for each resource being detached from the endpoint gateway (such as a security group)

  • is.subnet.reserved-ip.delete

    Generated for each reserved IP in ips for which auto_delete is true

  • is.security-group.security-group.detach

    Generated for each security group in security_groups.

Retrieve an endpoint gateway

This request retrieves a single endpoint gateway specified by the identifier in the URL.

This request retrieves a single endpoint gateway specified by the identifier in the URL.

This request retrieves a single endpoint gateway specified by the identifier in the URL.

This request retrieves a single endpoint gateway specified by the identifier in the URL.

This request retrieves a single endpoint gateway specified by the identifier in the URL.

GET /endpoint_gateways/{id}
(vpc *VpcV1) GetEndpointGateway(getEndpointGatewayOptions *GetEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetEndpointGatewayWithContext(ctx context.Context, getEndpointGatewayOptions *GetEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error)
get_endpoint_gateway(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<EndpointGateway> getEndpointGateway(GetEndpointGatewayOptions getEndpointGatewayOptions)
getEndpointGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.endpoint-gateway.endpoint-gateway.read

Auditing

Calling this method generates the following auditing event.

  • is.endpoint-gateway.endpoint-gateway.read

Update an endpoint gateway

This request updates an endpoint gateway's name.

This request updates an endpoint gateway's name.

This request updates an endpoint gateway's name.

This request updates an endpoint gateway's name.

This request updates an endpoint gateway's name.

PATCH /endpoint_gateways/{id}
(vpc *VpcV1) UpdateEndpointGateway(updateEndpointGatewayOptions *UpdateEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateEndpointGatewayWithContext(ctx context.Context, updateEndpointGatewayOptions *UpdateEndpointGatewayOptions) (result *EndpointGateway, response *core.DetailedResponse, err error)
update_endpoint_gateway(
        self,
        id: str,
        endpoint_gateway_patch: 'EndpointGatewayPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<EndpointGateway> updateEndpointGateway(UpdateEndpointGatewayOptions updateEndpointGatewayOptions)
updateEndpointGateway(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.endpoint-gateway.endpoint-gateway.update

Auditing

Calling this method generates the following auditing event.

  • is.endpoint-gateway.endpoint-gateway.update

List all flow log collectors

This request lists all flow log collectors in the region. A flow log collector summarizes data sent over the instance network interfaces and instance network attachments contained within its target.

This request lists all flow log collectors in the region. A flow log collector summarizes data sent over the instance network interfaces and instance network attachments contained within its target.

This request lists all flow log collectors in the region. A flow log collector summarizes data sent over the instance network interfaces and instance network attachments contained within its target.

This request lists all flow log collectors in the region. A flow log collector summarizes data sent over the instance network interfaces and instance network attachments contained within its target.

This request lists all flow log collectors in the region. A flow log collector summarizes data sent over the instance network interfaces and instance network attachments contained within its target.

GET /flow_log_collectors
(vpc *VpcV1) ListFlowLogCollectors(listFlowLogCollectorsOptions *ListFlowLogCollectorsOptions) (result *FlowLogCollectorCollection, response *core.DetailedResponse, err error)
(vpc *VpcV1) ListFlowLogCollectorsWithContext(ctx context.Context, listFlowLogCollectorsOptions *ListFlowLogCollectorsOptions) (result *FlowLogCollectorCollection, response *core.DetailedResponse, err error)
list_flow_log_collectors(
        self,
        *,
        start: Optional[str] = None,
        limit: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        name: Optional[str] = None,
        vpc_id: Optional[str] = None,
        vpc_crn: Optional[str] = None,
        vpc_name: Optional[str] = None,
        target_id: Optional[str] = None,
        target_resource_type: Optional[str] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FlowLogCollectorCollection> listFlowLogCollectors(ListFlowLogCollectorsOptions listFlowLogCollectorsOptions)
listFlowLogCollectors(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.flow-log-collector.flow-log-collector.read

Auditing

Calling this method generates the following auditing event.

  • is.flow-log-collector.flow-log-collector.read

Create a flow log collector

This request creates and starts a new flow log collector from a flow log collector prototype object. The prototype object is structured in the same way as a retrieved flow log collector, and contains the information necessary to create and start the new flow log collector.

This request creates and starts a new flow log collector from a flow log collector prototype object. The prototype object is structured in the same way as a retrieved flow log collector, and contains the information necessary to create and start the new flow log collector.

This request creates and starts a new flow log collector from a flow log collector prototype object. The prototype object is structured in the same way as a retrieved flow log collector, and contains the information necessary to create and start the new flow log collector.

This request creates and starts a new flow log collector from a flow log collector prototype object. The prototype object is structured in the same way as a retrieved flow log collector, and contains the information necessary to create and start the new flow log collector.

This request creates and starts a new flow log collector from a flow log collector prototype object. The prototype object is structured in the same way as a retrieved flow log collector, and contains the information necessary to create and start the new flow log collector.

POST /flow_log_collectors
(vpc *VpcV1) CreateFlowLogCollector(createFlowLogCollectorOptions *CreateFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error)
(vpc *VpcV1) CreateFlowLogCollectorWithContext(ctx context.Context, createFlowLogCollectorOptions *CreateFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error)
create_flow_log_collector(
        self,
        storage_bucket: 'LegacyCloudObjectStorageBucketIdentity',
        target: 'FlowLogCollectorTargetPrototype',
        *,
        active: Optional[bool] = None,
        name: Optional[str] = None,
        resource_group: Optional['ResourceGroupIdentity'] = None,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FlowLogCollector> createFlowLogCollector(CreateFlowLogCollectorOptions createFlowLogCollectorOptions)
createFlowLogCollector(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following actions, depending on any listed conditions. You can check your access by going to Users > User > Access.

  • is.flow-log-collector.flow-log-collector.create

  • is.vpc.vpc.operate

    Required when target specifies a VPC

  • is.subnet.subnet.operate

    Required when target specifies a subnet

  • is.instance.instance.operate

    Required when target specifies an instance, instance network attachment or instance network interface

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.flow-log-collector.flow-log-collector.create

  • is.flow-log-collector.flow-log-collector.attach

  • is.instance.instance.attach

    Generated when target specifies a virtual server instance

  • is.instance.network-attachment.attach

    Generated when target specifies an instance network attachment

  • is.instance.network-interface.attach

    Generated when target specifies an instance network interface

  • is.subnet.subnet.attach

    Generated when target specifies a subnet

  • is.virtual-network-interface.virtual-network-interface.attach

    Generated when target specifies a virtual network interface

  • is.vpc.vpc.attach

    Generated when target specifies a VPC

Delete a flow log collector

This request stops and deletes a flow log collector. This operation cannot be reversed.

Collected flow logs remain available within the flow log collector's Cloud Object Storage bucket.

This request stops and deletes a flow log collector. This operation cannot be reversed.

Collected flow logs remain available within the flow log collector's Cloud Object Storage bucket.

This request stops and deletes a flow log collector. This operation cannot be reversed.

Collected flow logs remain available within the flow log collector's Cloud Object Storage bucket.

This request stops and deletes a flow log collector. This operation cannot be reversed.

Collected flow logs remain available within the flow log collector's Cloud Object Storage bucket.

This request stops and deletes a flow log collector. This operation cannot be reversed.

Collected flow logs remain available within the flow log collector's Cloud Object Storage bucket.

DELETE /flow_log_collectors/{id}
(vpc *VpcV1) DeleteFlowLogCollector(deleteFlowLogCollectorOptions *DeleteFlowLogCollectorOptions) (response *core.DetailedResponse, err error)
(vpc *VpcV1) DeleteFlowLogCollectorWithContext(ctx context.Context, deleteFlowLogCollectorOptions *DeleteFlowLogCollectorOptions) (response *core.DetailedResponse, err error)
delete_flow_log_collector(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<Void> deleteFlowLogCollector(DeleteFlowLogCollectorOptions deleteFlowLogCollectorOptions)
deleteFlowLogCollector(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.flow-log-collector.flow-log-collector.delete

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

  • is.flow-log-collector.flow-log-collector.delete

  • is.flow-log-collector.flow-log-collector.detach

  • is.instance.instance.detach

    Generated for a flow log collector that was attached to an instance

  • is.instance.network-interface.detach

    Generated for a flow log collector that was attached to an instance network interface

  • is.instance.network-attachment.detach

    Generated for a flow log collector that was attached to an instance network attachment

  • is.subnet.subnet.detach

    Generated for a flow log collector that was attached to a subnet

  • is.virtual-network-interface.virtual-network-interface.detach

    Generated for a flow log collector that was attached to a virtual network interface

  • is.vpc.vpc.detach

    Generated for a flow log collector that was attached to a VPC

Retrieve a flow log collector

This request retrieves a single flow log collector specified by the identifier in the URL.

This request retrieves a single flow log collector specified by the identifier in the URL.

This request retrieves a single flow log collector specified by the identifier in the URL.

This request retrieves a single flow log collector specified by the identifier in the URL.

This request retrieves a single flow log collector specified by the identifier in the URL.

GET /flow_log_collectors/{id}
(vpc *VpcV1) GetFlowLogCollector(getFlowLogCollectorOptions *GetFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error)
(vpc *VpcV1) GetFlowLogCollectorWithContext(ctx context.Context, getFlowLogCollectorOptions *GetFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error)
get_flow_log_collector(
        self,
        id: str,
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FlowLogCollector> getFlowLogCollector(GetFlowLogCollectorOptions getFlowLogCollectorOptions)
getFlowLogCollector(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.flow-log-collector.flow-log-collector.read

Auditing

Calling this method generates the following auditing event.

  • is.flow-log-collector.flow-log-collector.read

Update a flow log collector

This request updates a flow log collector with the information in a provided flow log collector patch. The flow log collector patch object is structured in the same way as a retrieved flow log collector and contains only the information to be updated.

This request updates a flow log collector with the information in a provided flow log collector patch. The flow log collector patch object is structured in the same way as a retrieved flow log collector and contains only the information to be updated.

This request updates a flow log collector with the information in a provided flow log collector patch. The flow log collector patch object is structured in the same way as a retrieved flow log collector and contains only the information to be updated.

This request updates a flow log collector with the information in a provided flow log collector patch. The flow log collector patch object is structured in the same way as a retrieved flow log collector and contains only the information to be updated.

This request updates a flow log collector with the information in a provided flow log collector patch. The flow log collector patch object is structured in the same way as a retrieved flow log collector and contains only the information to be updated.

PATCH /flow_log_collectors/{id}
(vpc *VpcV1) UpdateFlowLogCollector(updateFlowLogCollectorOptions *UpdateFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error)
(vpc *VpcV1) UpdateFlowLogCollectorWithContext(ctx context.Context, updateFlowLogCollectorOptions *UpdateFlowLogCollectorOptions) (result *FlowLogCollector, response *core.DetailedResponse, err error)
update_flow_log_collector(
        self,
        id: str,
        flow_log_collector_patch: 'FlowLogCollectorPatch',
        **kwargs,
    ) -> DetailedResponse
ServiceCall<FlowLogCollector> updateFlowLogCollector(UpdateFlowLogCollectorOptions updateFlowLogCollectorOptions)
updateFlowLogCollector(params)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

  • is.flow-log-collector.flow-log-collector.update

Auditing

Calling this method generates the following auditing event.

  • is.flow-log-collector.flow-log-collector.update