Query O&M item details using GetOpsItem - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Queries the details of an O&M item.

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:GetOpsItem

get

*OpsItem

acs:oos:{#regionId}:{#accountId}:opsitem/{#OpsItemId}

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
OpsItemId	string	Yes	The O&M item ID.	oi-d52b08695e2b46ae8413

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8BED4C16-BD30-5E27-94D4-7EBCCECF70C1
OpsItem	object	The O&M item details.
OpsItemId	string	The O&M item ID.	oi-d52b08695e2b46ae8413
CreateDate	string	The time when the O&M item was created.	2023-04-10T06:15Z
UpdateDate	string	The time when the O&M item was updated.	2023-04-10T06:15Z
Title	string	The title of the O&M item.	test
Status	string	The status of the O&M item.	Open
Severity	string	The severity level of the O&M item.	Medium
Category	string	The category of the O&M item.	Security
Source	string	The source business of the O&M item.	/aliyun/appManager
Priority	integer	The priority of the O&M item.	1
Tags	object	The tags of the O&M item.	{"K1":"V1"}
Solutions	array<object>	The solutions for the O&M item.
	object	The solution.
Resources	array	The Alibaba Cloud Resource Names (ARNs) of the resources associated with the O&M item.
	string	The ARN of the associated resource.	[\"arn:acs:ecs:cn-hangzhou:1770150251620858:instance/i-bp12tnoea6nwofva06e8\"]
ResourceGroupId	string	The ID of the resource group.	rg-aekzxkofnlxtn2i
Description	string	The description.	test-update
CreateBy	string	The user who created the O&M item.	root(130900000)
LastModifiedBy	string	The user who last modified the O&M item.	modifiedBy
Attributes	object	The attributes of the O&M item.

Examples

Success response

JSON format

{
  "RequestId": "8BED4C16-BD30-5E27-94D4-7EBCCECF70C1",
  "OpsItem": {
    "OpsItemId": "oi-d52b08695e2b46ae8413\n",
    "CreateDate": "2023-04-10T06:15Z",
    "UpdateDate": "2023-04-10T06:15Z\n",
    "Title": "test",
    "Status": "Open",
    "Severity": "Medium",
    "Category": "Security",
    "Source": "/aliyun/appManager",
    "Priority": 1,
    "Tags": {
      "K1": "V1"
    },
    "Solutions": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "Resources": [
      "[\\\"arn:acs:ecs:cn-hangzhou:1770150251620858:instance/i-bp12tnoea6nwofva06e8\\\"]"
    ],
    "ResourceGroupId": "rg-aekzxkofnlxtn2i",
    "Description": "test-update",
    "CreateBy": "root(130900000)\n",
    "LastModifiedBy": "modifiedBy",
    "Attributes": {
      "test": "test",
      "test2": 1
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.