Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetOdbNetwork

Returns information about the specified ODB network.

Request Syntax


{
   "odbNetworkId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

odbNetworkId

The unique identifier of the ODB network.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 2048.

Pattern: (arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})

Required: Yes

Response Syntax


{
   "odbNetwork": { 
      "availabilityZone": "string",
      "availabilityZoneId": "string",
      "backupSubnetCidr": "string",
      "clientSubnetCidr": "string",
      "createdAt": "string",
      "customDomainName": "string",
      "defaultDnsPrefix": "string",
      "displayName": "string",
      "managedServices": { 
         "managedS3BackupAccess": { 
            "ipv4Addresses": [ "string" ],
            "status": "string"
         },
         "managedServicesIpv4Cidrs": [ "string" ],
         "resourceGatewayArn": "string",
         "s3Access": { 
            "domainName": "string",
            "ipv4Addresses": [ "string" ],
            "s3PolicyDocument": "string",
            "status": "string"
         },
         "serviceNetworkArn": "string",
         "serviceNetworkEndpoint": { 
            "vpcEndpointId": "string",
            "vpcEndpointType": "string"
         },
         "zeroEtlAccess": { 
            "cidr": "string",
            "status": "string"
         }
      },
      "ociDnsForwardingConfigs": [ 
         { 
            "domainName": "string",
            "ociDnsListenerIp": "string"
         }
      ],
      "ociNetworkAnchorId": "string",
      "ociNetworkAnchorUrl": "string",
      "ociResourceAnchorName": "string",
      "ociVcnId": "string",
      "ociVcnUrl": "string",
      "odbNetworkArn": "string",
      "odbNetworkId": "string",
      "peeredCidrs": [ "string" ],
      "percentProgress": number,
      "status": "string",
      "statusReason": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

odbNetwork

The ODB network.

Type: OdbNetwork object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

HTTP Status Code: 400

InternalServerException

Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.

retryAfterSeconds: The number of seconds to wait before retrying the request after an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

resourceId: The identifier of the resource that was not found.
resourceType: The type of resource that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

retryAfterSeconds: The number of seconds to wait before retrying the request after being throttled.

HTTP Status Code: 400

ValidationException

The request has failed validation because it is missing required fields or has invalid inputs.

fieldList: A list of fields that failed validation.
reason: The reason why the validation failed.

HTTP Status Code: 400