ContainerInstanceClient

class oci.container_instances.ContainerInstanceClient(config, **kwargs)

A description of the Container Instance API

Methods

__init__(config, **kwargs)	Creates a new service client
change_container_instance_compartment(…)	Moves a container instance resource from one compartment identifier to another.
create_container_instance(…)	Creates a container instance and deploys the containers on it.
delete_container_instance(…)	Deletes a container instance and its containers.
get_container(container_id, **kwargs)	Get details about a single container by the container ID.
get_container_instance(…)	Gets information about the specified container instance.
get_work_request(work_request_id, **kwargs)	Gets the status of the work request with the given ID.
list_container_instance_shapes(…)	Lists the shapes that can be used to create container instances.
list_container_instances(compartment_id, …)	Returns a list of container instances.
list_containers(compartment_id, **kwargs)	Returns a list of containers in a compartment.
list_work_request_errors(work_request_id, …)	Returns a paginated list of errors for a work request.
list_work_request_logs(work_request_id, **kwargs)	Returns a paginated list of logs for a work request.
list_work_requests(compartment_id, **kwargs)	Lists the work requests in a compartment.
restart_container_instance(…)	Restarts a container instance.
retrieve_logs(container_id, **kwargs)	Returns the most recent 256 KB of logs from the specified container.
start_container_instance(…)	Starts a container instance if it is “inactive”.
stop_container_instance(…)	Stops a container instance if it is “active”.
update_container(container_id, …)	Updates a container.
update_container_instance(…)	Updates a container instance.

__init__(config, **kwargs)

Creates a new service client

Parameters:

• config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
• service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
• timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
• signer (AbstractBaseSigner) –

  (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

  One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

• retry_strategy (obj) –

  (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

  This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

• circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
• circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
• client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
• allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_container_instance_compartment(container_instance_id, change_container_instance_compartment_details, **kwargs)

Moves a container instance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

• container_instance_id (str) –

  (required) The OCID of the container instance.

• change_container_instance_compartment_details (oci.container_instances.models.ChangeContainerInstanceCompartmentDetails) – (required) The information to be updated.
• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_container_instance_compartment API.

create_container_instance(create_container_instance_details, **kwargs)

Creates a container instance and deploys the containers on it.

Parameters:

• create_container_instance_details (oci.container_instances.models.CreateContainerInstanceDetails) – (required) Details for the new container instance.
• opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type ContainerInstance

Return type:

Response

Example:

Click here to see an example of how to use create_container_instance API.

delete_container_instance(container_instance_id, **kwargs)

Deletes a container instance and its containers.

Parameters:

• container_instance_id (str) –

  (required) The OCID of the container instance.

• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_container_instance API.

get_container(container_id, **kwargs)

Get details about a single container by the container ID.

Parameters:

• container_id (str) –

  (required) The OCID of the container.

• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type Container

Return type:

Response

Example:

Click here to see an example of how to use get_container API.

get_container_instance(container_instance_id, **kwargs)

Gets information about the specified container instance.

Parameters:

• container_instance_id (str) –

  (required) The OCID of the container instance.

• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type ContainerInstance

Return type:

Response

Example:

Click here to see an example of how to use get_container_instance API.

get_work_request(work_request_id, **kwargs)

Gets the status of the work request with the given ID.

Parameters:

• work_request_id (str) – (required) The ID of the asynchronous request.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_work_request API.

list_container_instance_shapes(compartment_id, **kwargs)

Lists the shapes that can be used to create container instances.

Parameters:

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• availability_domain (str) –

  (optional) The name of the availability domain.

  Example: Uocm:PHX-AD-1

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• page (str) –

  (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type ContainerInstanceShapeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_container_instance_shapes API.

list_container_instances(compartment_id, **kwargs)

Returns a list of container instances.

Parameters:

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

  (optional) A filter to only return resources that match the given lifecycle state.

  Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the entire display name given.
• availability_domain (str) –

  (optional) The name of the availability domain.

  Example: Uocm:PHX-AD-1

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• page (str) –

  (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• sort_order (str) –

  (optional) The sort order to use (ASC) or (DESC).

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

  (optional) The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don’t specify a value, timeCreated is the default.

  Allowed values are: “timeCreated”, “displayName”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type ContainerInstanceCollection

Return type:

Response

Example:

Click here to see an example of how to use list_container_instances API.

list_containers(compartment_id, **kwargs)

Returns a list of containers in a compartment.

Parameters:

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• lifecycle_state (str) –

  (optional) A filter to only return resources that match the given lifecycle state.

  Allowed values are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) A filter to return only resources that match the entire display name given.
• container_instance_id (str) –

  (optional) The OCID of the container instance.

• availability_domain (str) –

  (optional) The name of the availability domain.

  Example: Uocm:PHX-AD-1

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• page (str) –

  (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• sort_order (str) –

  (optional) The sort order to use (ASC) or (DESC).

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

  (optional) The field to sort by. You can provide one sort order. Default order for timeCreated is descending. Default order for displayName is ascending. If you don’t specify a value, timeCreated is the default.

  Allowed values are: “timeCreated”, “displayName”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type ContainerCollection

Return type:

Response

Example:

Click here to see an example of how to use list_containers API.

list_work_request_errors(work_request_id, **kwargs)

Returns a paginated list of errors for a work request.

Parameters:

• work_request_id (str) – (required) The ID of the asynchronous request.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• page (str) –

  (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• sort_by (str) –

  (optional) The field to sort by. You can provide one sort order. Default order for timestamp is descending.

  Allowed values are: “timestamp”

• sort_order (str) –

  (optional) The sort order to use, either ascending (ASC) or descending (DESC).

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)

Returns a paginated list of logs for a work request.

Parameters:

• work_request_id (str) – (required) The ID of the asynchronous request.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• page (str) –

  (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• sort_by (str) –

  (optional) The field to sort by. You can provide one sort order. Default order for timestamp is descending.

  Allowed values are: “timestamp”

• sort_order (str) –

  (optional) The sort order to use, either ascending (ASC) or descending (DESC).

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestLogEntryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(compartment_id, **kwargs)

Lists the work requests in a compartment.

Parameters:

• compartment_id (str) –

  (required) The OCID of the compartment in which to list resources.

• work_request_id (str) – (optional) The ID of the asynchronous work request.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• page (str) –

  (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• availability_domain (str) –

  (optional) The name of the availability domain.

  Example: Uocm:PHX-AD-1

• status (str) –

  (optional) A filter to return resources with a lifecycleState that matches the given OperationStatus.

  Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

• sort_by (str) –

  (optional) The field to sort by. You can provide one sort order. Default order for timeAccepted is descending.

  Allowed values are: “timeAccepted”

• sort_order (str) –

  (optional) The sort order to use, either ascending (ASC) or descending (DESC).

  Allowed values are: “ASC”, “DESC”

• resource_id (str) – (optional) The OCID of the resource affected by the work request.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestSummaryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_requests API.

restart_container_instance(container_instance_id, **kwargs)

Restarts a container instance. When provided, If-Match is checked against ETag values of the container instance.

Parameters:

• container_instance_id (str) –

  (required) The OCID of the container instance.

• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use restart_container_instance API.

retrieve_logs(container_id, **kwargs)

Returns the most recent 256 KB of logs from the specified container.

Parameters:

• container_id (str) –

  (required) The OCID of the container.

• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• is_previous (bool) – (optional) Returns the logs for the previous run of the container in a pod. If the container fails, this parameter can help you to determine the root cause of the failure.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use retrieve_logs API.

start_container_instance(container_instance_id, **kwargs)

Starts a container instance if it is “inactive”. No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.

Parameters:

• container_instance_id (str) –

  (required) The OCID of the container instance.

• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use start_container_instance API.

stop_container_instance(container_instance_id, **kwargs)

Stops a container instance if it is “active”. No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.

Parameters:

• container_instance_id (str) –

  (required) The OCID of the container instance.

• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use stop_container_instance API.

update_container(container_id, update_container_details, **kwargs)

Updates a container.

Parameters:

• container_id (str) –

  (required) The OCID of the container.

• update_container_details (oci.container_instances.models.UpdateContainerDetails) – (required) The information to be updated.
• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_container API.

update_container_instance(container_instance_id, update_container_instance_details, **kwargs)

Updates a container instance.

Parameters:

• container_instance_id (str) –

  (required) The OCID of the container instance.

• update_container_instance_details (oci.container_instances.models.UpdateContainerInstanceDetails) – (required) The information to be updated.
• if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
• opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_container_instance API.