Subscribe Targets to an Image
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/goldImages/{goldImageId}/actions/subscribeTargets
Subscribes targets to an image. Targets can be of the same release (for patching purposes) or can be of a lower release from which a direct upgrade path is available.
Request
Path Parameters
-
goldImageId(required): string
ID of the image
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Match All
Show Source
-
object
allOf
SubscribeTargetsDetails
Details of subscription of targets
Nested Schema : SubscribeTargetsDetails
Type:
object
Details of subscription of targets
Match All
Show Source
-
object
TargetList
List of targets
-
object
SubscribeTargetCommonDetails
Common details for subscription of a target to the image
Nested Schema : TargetList
Type:
object
List of targets
Show Source
-
targetList: array
targetList
Array of target names
-
targetType: string
Target typeExample:
oracle_database
Nested Schema : SubscribeTargetCommonDetails
Type:
object
Common details for subscription of a target to the image
Show Source
-
isGimr: boolean
GIMR Flag
-
isNoCascade: boolean
Default Value:
false
Flag to indicate the subscription of PDBs in a CDB -
isStandbyAutoSubscribe: boolean
Default Value:
true
Flag to indicate the auto subscription of a standby database
Nested Schema : targetList
Type:
array
Array of target names
Show Source
-
Array of:
string
Example:
db1, db2
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
Ok. Targets subscribed.
Root Schema : schema
Type:
object
Match All
Show Source
-
object
allOf
GoldImageSubscribeTargets
Targets subscription response
Nested Schema : GoldImageSubscribeTargets
Type:
object
Targets subscription response
Match All
Show Source
-
object
GoldImageTargetsSubscriptionSummary
Targets subscription details
Nested Schema : GoldImageTargetsSubscriptionSummary
Type:
object
Targets subscription details
Show Source
-
failed: integer
Count of Failed targets
-
items: array
items
List of subscription summary
-
successful: integer
Count of Successful targets
-
total: integer
Count of Total targets
Nested Schema : items
Type:
array
List of subscription summary
Show Source
-
Array of:
object SubscriptionSummary
Target subscription summary
Nested Schema : SubscriptionSummary
Type:
object
Target subscription summary
Show Source
-
code: integer
HTTP status code
-
message: string
Message of subscription
-
targetId: string
ID of the targetExample:
01DB50F6963F0E39C72F8651DCC93A6A
-
targetName: string
Name of the targetExample:
sales_db1
-
targetType: string
Target typeExample:
oracle_database
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