MetadataClient

class oci.multicloud.MetadataClient(config, **kwargs)

Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see <link to docs>.

Methods

__init__(config, **kwargs) Creates a new service client
list_external_location_details_metadata(…) List externalLocationDetail metadata from OCI to Cloud Service Provider for regions, Availability Zones, and Cluster Placement Group ID.
list_external_location_mapping_metadata(…) List externalLocation metadata from OCI to the Cloud Service Provider for regions, Physical Availability Zones.
list_external_location_summaries_metadata(…) List externalLocationSummary metadata from OCI Region to the Cloud Service Provider region across all regions.
__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.
list_external_location_details_metadata(subscription_id, compartment_id, subscription_service_name, **kwargs)

List externalLocationDetail metadata from OCI to Cloud Service Provider for regions, Availability Zones, and Cluster Placement Group ID. examples:

application-json: |
[
{
“externalLocation”: {

“cspRegion”: “East US”, “cspPhysicalAz”: “az1-xyz”, “cspPhysicalAzDisplayName”: “(US) East US 2”, “cspLogicalAz”: “az1”, “serviceName”: “ORACLEDBATAZURE”, “cspZoneKeyReferenceId”: {

“keyName”: “AzureSubscriptionId or AwsAccountId, GcpProjectName”, “keyValue”: “azure-subscriptionId-1 or aws-account-id-1, gcp-project-id-1”

}

}, “ociPhysicalAd”: “ad1-xyb”, “ociLogicalAd”: “ad2”, “ociRegion”: “us-ashburn-1”, “cpgId”: “cpg-1”

},
{
“externalLocation”: {

“cspRegion”: “East US”, “cspPhysicalAz”: “az2-abc”, “cspPhysicalAzDisplayName”: “(US) East US 2”, “cspLogicalAz”: “az2”, “serviceName”: “ORACLEDBATAZURE”, “cspZoneKeyReferenceId”: {

“keyName”: “AzureSubscriptionId or AwsAccountId, GcpProjectName”, “keyValue”: “azure-subscriptionId-2 or aws-account-id-2, gcp-project-id-2”

}

}, “ociPhysicalAd”: “ad2-xby”, “ociLogicalAd”: “ad1”, “ociRegion”: “us-ashburn-1”, “cpgId”: “cpg-2”

}, {

“externalLocation”: {

“cspRegion”: “East US”, “cspPhysicalAz”: “az3-abz”, “cspPhysicalAzDisplayName”: “(US) East US 2”, “cspLogicalAz”: “az3”, “serviceName”: “ORACLEDBATAZURE”, “cspZoneKeyReferenceId”: {

“keyName”: “AzureSubscriptionId or AwsAccountId, GcpProjectName”, “keyValue”: “azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3”

}

}, “ociPhysicalAd”: “ad3-cde”, “ociLogicalAd”: “ad3”, “ociRegion”: “us-ashburn-1”, “cpgId”: “cpg-3”

}, {

“externalLocation”: {

“cspRegion”: “East US 2”, “cspPhysicalAz”: “az1-def”, “cspPhysicalAzDisplayName”: “(US) East US 2”, “cspLogicalAz”: “az1”, “serviceName”: “ORACLEDBATAZURE”, “cspZoneKeyReferenceId”: {

“keyName”: “AzureSubscriptionId or AwsAccountId, GcpProjectName”, “keyValue”: “azure-subscriptionId-4 or aws-account-id-4, gcp-project-id-4”

}

}, “ociPhysicalAd”: “ad1-bce”, “ociLogicalAd”: “ad2”, “ociRegion”: “us-ashburn-1”, “cpgId”: “cpg-4”

}, {

“externalLocation”: {

“cspRegion”: “East US 2”, “cspPhysicalAz”: “az2-uvw”, “cspPhysicalAzDisplayName”: “(US) East US 2”, “cspLogicalAz”: “az2”, “serviceName”: “ORACLEDBATAZURE”, “cspZoneKeyReferenceId”: {

“keyName”: “AzureSubscriptionId or AwsAccountId, GcpProjectName”, “keyValue”: “azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3”

}

}, “ociPhysicalAd”: “ad2-ftc”, “ociLogicalAd”: “ad1”, “ociRegion”: “us-ashburn-1”, “cpgId”: “cpg-5”

}, {

“externalLocation”: {

“cspRegion”: “East US 2”, “cspPhysicalAz”: “az3-uvw”, “cspPhysicalAzDisplayName”: “(US) East US 2”, “cspLogicalAz”: “az3”, “serviceName”: “ORACLEDBATAZURE”, “cspZoneKeyReferenceId”: {

“keyName”: “AzureSubscriptionId or AwsAccountId, GcpProjectName”, “keyValue”: “azure-subscriptionId-3 or aws-account-id-3, gcp-project-id-3”

}

}, “ociPhysicalAd”: “ad3-stc”, “ociLogicalAd”: “ad3”, “ociRegion”: “us-ashburn-1”, “cpgId”: “cpg-6”

}

]

Parameters:
  • subscription_id (str) –

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

  • compartment_id (str) –

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

  • subscription_service_name (str) –

    (required) The subscription service name values from [ORACLEDBATAZURE, ORACLEDBATGOOGLE, ORACLEDBATAWS]

    Allowed values are: “ORACLEDBATAZURE”, “ORACLEDBATGOOGLE”, “ORACLEDBATAWS”

  • entity_type (str) –

    (optional) The resource type query (i.e. dbsystem, instance etc.)

    Allowed values are: “dbsystem”

  • linked_compartment_id (str) –

    (optional) The OCID of the compartment in which linked to Resource.

  • 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.

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending.

    Allowed values are: “timeCreated”, “displayName”

  • 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. The only valid characters for request IDs are letters, numbers, underscore, and dash.
  • 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 ExternalLocationsMetadatumCollection
Return type:

Response
Example:

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

list_external_location_mapping_metadata(subscription_service_name, compartment_id, **kwargs)

List externalLocation metadata from OCI to the Cloud Service Provider for regions, Physical Availability Zones. examples:

application-json: |
[
{
“externalLocation”: {
“cspRegion”: “eastus”, “cspPhysicalAz”: “eastus-az1”, “cspPhysicalAzDisplayName”: “(US) East US 1”, “serviceName”: “ORACLEDBATAZURE”

}, “ociPhysicalAd”: “iad-ad-1”, “ociLogicalAd”: “ad1”, “ociRegion”: “us-ashburn-1”

},
{
“externalLocation”: {
“cspRegion”: “eastus”, “cspPhysicalAz”: “eastus-az1”, “cspPhysicalAzDisplayName”: “(US) East US 1”, “serviceName”: “ORACLEDBATAZURE”

}, “ociPhysicalAd”: “iad-ad-1”, “ociLogicalAd”: “ad1”, “ociRegion”: “us-ashburn-1”

}, {

“externalLocation”: {
“cspRegion”: “eastus2”, “cspPhysicalAz”: “eastus2-az3”, “cspPhysicalAzDisplayName”: “(US) East US 1”, “serviceName”: “ORACLEDBATAZURE”

}, “ociPhysicalAd”: “iad-ad-2”, “ociLogicalAd”: “ad1”, “ociRegion”: “us-ashburn-1”

}, {

“externalLocation”: {
“cspRegion”: “eastus”, “cspPhysicalAz”: “eastus-az3” “cspPhysicalAzDisplayName”: “(US) East US 1”, “serviceName”: “ORACLEDBATAZURE”

}, “ociPhysicalAd”: “iad-ad-333”, “ociLogicalAd”: “ad1”, “ociRegion”: “us-ashburn-1”

}

]

Parameters:
  • subscription_service_name (oci.multicloud.models.list[str]) –

    (required) The subscription type values from [ORACLEDBATAZURE, ORACLEDBATGOOGLE, ORACLEDBATAWS]

    Allowed values are: “ORACLEDBATAZURE”, “ORACLEDBATGOOGLE”, “ORACLEDBATAWS”

  • compartment_id (str) –

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

  • subscription_id (str) –

    (optional) The OCID of the subscription in which to list resources.

  • 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.

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending.

    Allowed values are: “timeCreated”, “displayName”

  • 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. The only valid characters for request IDs are letters, numbers, underscore, and dash.
  • 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 ExternalLocationMappingMetadatumSummaryCollection
Return type:

Response
Example:

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

list_external_location_summaries_metadata(subscription_service_name, compartment_id, **kwargs)

List externalLocationSummary metadata from OCI Region to the Cloud Service Provider region across all regions. examples:

application-json: |
[
{
“externalLocation”: {
“cspRegion”: “East US”

}, “ociRegion”: “us-ashburn-1”

},
{
“externalLocation”: {
“cspRegion”: “East US 2”

}, “ociRegion”: “us-ashburn-1”

}, {

“externalLocation”: {
“cspRegion”: “Germany West Central”

}, “ociRegion”: “eu-frankfurt-1”,

}

]

Parameters:
  • subscription_service_name (str) –

    (required) The subscription service name values from [ORACLEDBATAZURE, ORACLEDBATGOOGLE, ORACLEDBATAWS]

    Allowed values are: “ORACLEDBATAZURE”, “ORACLEDBATGOOGLE”, “ORACLEDBATAWS”

  • compartment_id (str) –

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

  • subscription_id (str) –

    (optional) The OCID of the subscription in which to list resources.

  • entity_type (str) –

    (optional) The resource type query (i.e. dbsystem, instance etc.)

    Allowed values are: “dbsystem”

  • 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.

  • sort_order (str) –

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

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending.

    Allowed values are: “timeCreated”, “displayName”

  • 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. The only valid characters for request IDs are letters, numbers, underscore, and dash.
  • 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 ExternalLocationSummariesMetadatumSummaryCollection
Return type:

Response
Example:

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