GetPatchBaseline - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Queries the details of a patch baseline.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oos:GetPatchBaseline

get

*patchbaseline

acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Name	string	Yes	The name of the patch baseline.	MyPatchBaseline

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	2C630E64-7273-57AC-A598-1B2B8B35CEA5
PatchBaseline	object	The details of the patch baseline.
OperationSystem	string	The type of the operating system.	Windows
IsDefault	boolean	Indicates whether the patch baseline is the default one.	false
Description	string	The description of the patch baseline.	UpdatePatchBaseline
UpdatedDate	string	The time when the patch baseline was updated.	2021-09-08T07:26:38Z
UpdatedBy	string	The user who updated the patch baseline.	root(130900000)
CreatedBy	string	The user who created the patch baseline.	root(130900000)
CreatedDate	string	The time when the patch baseline was created.	2021-09-07T03:42:56Z
Name	string	The name of the patch baseline.	MypatchBaseline
ApprovalRules	string	The approval rules.	{"PatchRules":[{"PatchFilterGroup":[{"Key":"PatchSet","Values":["OS"]},{"Key":"ProductFamily","Values":["Windows"]},{"Key":"Product","Values":["Windows 10","Windows 7"]},{"Key":"Classification","Values":["Security Updates","Updates","Update Rollups","Critical Updates"]},{"Key":"Severity","Values":["Critical","Important","Moderate"]}],"ApproveAfterDays":7,"ApproveUntilDate":"","EnableNonSecurity":true,"ComplianceLevel":"Medium"}]}
Id	string	The ID of the patch baseline.	pb-445340b5c6504a85a300
ShareType	string	The share type of the patch baseline.	Private
RejectedPatches	array	The names of the rejected patches.
	string	The name of the rejected patch.	RejectedPatch1
RejectedPatchesAction	string	The action for rejected patches.	ALLOW_AS_DEPENDENCY
ApprovedPatches	array	A list of approved patches.
	string	The name of the approved patch.	ApprovedPatch1
ApprovedPatchesEnableNonSecurity	boolean	Indicates whether the approved patches include updates other than security updates.	true
Sources	array	A list of patch source configurations.
	string	The patch source configuration.	[main] name=MyCustomRepository baseurl=https://my-custom-repository enabled=1
Tags	array<object>	The tags.
	object	The tag.
TagKey	string	The tag key.	key
TagValue	string	The tag value.	value
ResourceGroupId	string	The resource group ID.	rg-acfmzmhzoaad5oq

Examples

Success response

JSON format

{
  "RequestId": "2C630E64-7273-57AC-A598-1B2B8B35CEA5",
  "PatchBaseline": {
    "OperationSystem": "Windows",
    "IsDefault": false,
    "Description": "UpdatePatchBaseline",
    "UpdatedDate": "2021-09-08T07:26:38Z",
    "UpdatedBy": "root(130900000)",
    "CreatedBy": "root(130900000)",
    "CreatedDate": "2021-09-07T03:42:56Z",
    "Name": "MypatchBaseline",
    "ApprovalRules": "{\"PatchRules\":[{\"PatchFilterGroup\":[{\"Key\":\"PatchSet\",\"Values\":[\"OS\"]},{\"Key\":\"ProductFamily\",\"Values\":[\"Windows\"]},{\"Key\":\"Product\",\"Values\":[\"Windows 10\",\"Windows 7\"]},{\"Key\":\"Classification\",\"Values\":[\"Security Updates\",\"Updates\",\"Update Rollups\",\"Critical Updates\"]},{\"Key\":\"Severity\",\"Values\":[\"Critical\",\"Important\",\"Moderate\"]}],\"ApproveAfterDays\":7,\"ApproveUntilDate\":\"\",\"EnableNonSecurity\":true,\"ComplianceLevel\":\"Medium\"}]}",
    "Id": "pb-445340b5c6504a85a300",
    "ShareType": "Private",
    "RejectedPatches": [
      "RejectedPatch1"
    ],
    "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY",
    "ApprovedPatches": [
      "ApprovedPatch1"
    ],
    "ApprovedPatchesEnableNonSecurity": true,
    "Sources": [
      "[main]\nname=MyCustomRepository\nbaseurl=https://my-custom-repository\nenabled=1"
    ],
    "Tags": [
      {
        "TagKey": "key",
        "TagValue": "value"
      }
    ],
    "ResourceGroupId": "rg-acfmzmhzoaad5oq"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.