Get Subscription Report of Targets
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/actions/targetsSubscriptionReport
Get subscription details of targets
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
exclusions: array
exclusions
Array of details to be excluded in response
-
limit: number
Limit for the current fetch (to fetch only the 'total' count of items need to set the limit=0)Example:
10
-
page: string
Base 64 encoded pageExample:
b2Zmc2V0OjA
-
sort: string
Sort field along with an optional sort direction. The supported attributes for sorting are 'targetName', 'targetType', 'hostName', 'dataguardRole', 'release', 'platform', 'targetStatus', 'clusterName', 'isSubscribed', 'dbMachineName'.Valid sort directions include asc and desc. If sort direction is not specified asc is used by default.Example:
name:asc
Match All
Show Source
-
object
TargetsSubscriptionReportFilter
Filters for targets subscription report
Nested Schema : exclusions
Type:
array
Array of details to be excluded in response
Show Source
-
Array of:
string
Allowed Values:
[ "TARGETS_DISTRIBUTION", "TOTAL" ]
Nested Schema : TargetsSubscriptionReportFilter
Type:
object
Filters for targets subscription report
Show Source
-
platform: string
Platform of the targetExample:
linux_x64_86
-
releaseMatches: string
Wildcard search on release of the targetExample:
19.14%
-
subscriptionType: string
Default Value:
BOTH
Allowed Values:[ "SUBSCRIBED", "NOT_SUBSCRIBED", "BOTH" ]
It describes the subscription type -
targetNameMatches: string
Wildcard search on the target nameExample:
%orcl%
-
targetProperties: object
targetProperties
Properties of target
-
targetTypes: array
targetTypes
Array of target types
Nested Schema : targetProperties
Type:
object
Properties of target
Match All
Show Source
-
object
TargetPropertyFilter
Target property filters
Nested Schema : targetTypes
Type:
array
Array of target types
Show Source
-
Array of:
Allowed Values:
[ "oracle_database", "rac_database", "cluster", "has" ]
Nested Schema : TargetPropertyFilter
Type:
object
Target property filters
Show Source
-
contactList: array
contactList
List of contacts
-
costCenterList: array
costCenterList
List of cost centers
-
departmentList: array
departmentList
List of departments
-
downtimeContactList: array
downtimeContactList
List of downtime contacts
-
lifecycleStatusList: array
lifecycleStatusList
List of lifecyclestatus
-
lineOfBusinessList: array
lineOfBusinessList
List of line of business
-
locationList: array
locationList
List of locations
-
siteList: array
siteList
List of sites
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
OK. Subscription report of targets retrieved.
Root Schema : schema
Type:
object
Match All
Show Source
-
object
TargetsSubscriptionReport
Target subscription details, which are subscribed/not subscribed to gold image
Nested Schema : TargetsSubscriptionReport
Type:
object
Target subscription details, which are subscribed/not subscribed to gold image
Show Source
-
count: number
Count of targets in the current fetchExample:
10
-
currentPage: string
Base 64 encoded current pageExample:
b2Zmc2V0OjA
-
items: array
items
Target details
-
nextPage: string
Base 64 encoded next pageExample:
b2Zmc2V0OjA
-
previousPage: string
Base 64 encoded previous pageExample:
b2Zmc2V0OjA
-
targetsDistribution: array
targetsDistribution
Statistics of targets grouped by targettype, release and platform
-
total: number
Total count of targetsExample:
20
Nested Schema : targetsDistribution
Type:
array
Statistics of targets grouped by targettype, release and platform
Show Source
Nested Schema : TargetSubscriptionDetails
Type:
object
Target details
Show Source
-
dbMachineName: string
DB Machine nameExample:
myDbMachine.oracle.com
-
isSubscribed: boolean
Flag to indicate if target is subscribedExample:
false
Match All
Show Source
-
object
TargetDetails
details of target
Nested Schema : TargetDetails
Type:
object
details of target
Show Source
-
clusterName: string
name of the clusterExample:
phxem0405c
-
dataguardRole: string
Enum for Data Guard role
-
displayName: string
display name of the targetExample:
sdb2ra00
-
hostname: string
name of the hostExample:
myHostName.mycompany.com
-
isCdb: string
Flag to indicate if the DB is CDBExample:
true
-
platform: string
Platform of the targetExample:
Linux_AMD64
-
release: string
database releaseExample:
19.14.0.0.0
-
targetId: string
Id of the targetExample:
09216A9333889316155C3B7DFF9820C7
-
targetName: string
name of the targetExample:
sdb2ra00
-
targetStatus: number
status of the targetExample:
1
-
targetType: string
Allowed Values:
[ "rac_database", "oracle_database", "cluster", "has" ]
type of the target
Nested Schema : items
Match All
Show Source
-
object
TargetsDistributionStatistics
Statistics of targets based on release and platform
Nested Schema : TargetsDistributionStatistics
Type:
object
Statistics of targets based on release and platform
Show Source
-
count: number
Count of targetsExample:
10
-
platform: string
Platform of the targetExample:
linux_x86_64
-
release: string
Database releaseExample:
19.14.0.0.0
-
targetType: string
Allowed Values:
[ "oracle_database", "rac_database", "has", "cluster" ]
Target type
Examples
400 Response
Bad Request. The payload is null or missing some parameters
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
403 Response
Forbidden. The user is forbidden to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
404 Response
Not Found. The requested REST API URL is not found.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
500 Response
Internal Server Error. Exception in execution of REST API.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string
503 Response
Service Unavailable. The server is unable to process the request.
Root Schema : ErrorResponse
Type:
object
Error response
Show Source
-
code(required): string
A short error code that defines the error, meant for programmatic parsing
-
message(required): string
A human-readable error string