DomainClient¶
-
class
oci.tenant_manager_control_plane.
DomainClient
(config, **kwargs)¶ Use the Organizations API to consolidate multiple OCI tenancies into an organization, and centrally manage your tenancies and organization resources. For more information, see [Organization Management Overview](/iaas/Content/General/Concepts/organization_management_overview.htm).
Methods
__init__
(config, **kwargs)Creates a new service client create_domain
(create_domain_details, **kwargs)Begins the registration process for claiming a domain. delete_domain
(domain_id, **kwargs)Releases the domain, making it available to be claimed again by another tenancy. get_domain
(domain_id, **kwargs)Gets information about the domain. list_domains
(compartment_id, **kwargs)Return a (paginated) list of domains. update_domain
(domain_id, …)Updates the domain. -
__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, adict
can be passed. You can validate_config the dict usingvalidate_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 convenienceDEFAULT_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.
- config (dict) – Configuration keys and values as per SDK and Tool Configuration.
The
-
create_domain
(create_domain_details, **kwargs)¶ Begins the registration process for claiming a domain.
Parameters: - create_domain_details (oci.tenant_manager_control_plane.models.CreateDomainDetails) – (required) Parameters for domain creation.
- 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 will be rejected.
- opc_request_id (str) – (optional) The client request ID for tracing.
- 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 will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. 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: Return type: Example: Click here to see an example of how to use create_domain API.
-
delete_domain
(domain_id, **kwargs)¶ Releases the domain, making it available to be claimed again by another tenancy.
Parameters: - domain_id (str) – (required) The domain OCID.
- 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) The client request ID for tracing.
- 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 will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. 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 NoneReturn type: Example: Click here to see an example of how to use delete_domain API.
-
get_domain
(domain_id, **kwargs)¶ Gets information about the domain.
Parameters: - domain_id (str) – (required) The domain OCID.
- opc_request_id (str) – (optional) The client request ID for tracing.
- 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 will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. 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: Return type: Example: Click here to see an example of how to use get_domain API.
-
list_domains
(compartment_id, **kwargs)¶ Return a (paginated) list of domains.
Parameters: - compartment_id (str) – (required) The ID of the compartment in which to list resources.
- domain_id (str) – (optional) The domain OCID.
- lifecycle_state (str) –
(optional) The lifecycle state of the resource.
Allowed values are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “FAILED”, “TERMINATED”
- status (str) –
(optional) The status of the domain.
Allowed values are: “PENDING”, “RELEASING”, “RELEASED”, “EXPIRING”, “REVOKING”, “REVOKED”, “ACTIVE”, “FAILED”
- name (str) – (optional) A filter to return only resources that exactly match the name given.
- opc_request_id (str) – (optional) The client request ID for tracing.
- page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
- limit (int) – (optional) The maximum number of items to return.
- sort_by (str) –
(optional) The field to sort by. Only one sort order can be provided. * The default order for timeCreated is descending. * The default order for displayName is ascending. * If no value is specified, timeCreated is the default.
Allowed values are: “timeCreated”, “displayName”
- sort_order (str) –
(optional) The sort order to use, whether ‘asc’ or ‘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 will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. 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 typeDomainCollection
Return type: Example: Click here to see an example of how to use list_domains API.
-
update_domain
(domain_id, update_domain_details, **kwargs)¶ Updates the domain.
Parameters: - domain_id (str) – (required) The domain OCID.
- update_domain_details (oci.tenant_manager_control_plane.models.UpdateDomainDetails) – (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) The client request ID for tracing.
- 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 will not retry by default, users can also use the convenientDEFAULT_RETRY_STRATEGY
provided by the SDK to enable retries for it. 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: Return type: Example: Click here to see an example of how to use update_domain API.
-