Retrieve OOS Application Details via GetApplication API - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Queries information about an application.

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

get

*Application

acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}

oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID. Set the value to cn-hangzhou.	cn-hangzhou
Name	string	Yes	The application name.	MyApplication

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	51004B8A-6D9A-5ACB-9158-6C6794496AD0
Application	object	The application details.
Description	string	The application description.	Application
UpdateDate	string	The time when the application was updated.	2021-09-07T09:17:46Z
ResourceGroupId	string	The resource group ID.	rg-acfmxsn4m******
Tags	object	The tags.	{"k1": "v1", "k2": "v2"}
Name	string	The application name.	MyApplication
CreateDate	string	The time when the application was created.	2021-09-07T09:17:46Z
ApplicationType	string	The application type. Valid values: ComputeNest Custom DingTalk	DingTalk
AlarmConfig	object	The alert configurations for the application.
ContactGroups	array	The alert contact groups.
	string	The alert contact group.	Alert contact group name
TemplateIds	array	The ID of the alert template.
	string	The ID of the alert template.	18ad7c9ddff24d1ba34aa76ec3944507
HealthCheckUrl	string	The health check URL for the application.	/api/health/
ServiceId	string	The ID of the Compute Nest service that corresponds to the application template.	service-79538e30e44541b699d8
ApplicationSource	string	The source of the application.	{"Platform":"gitee","Owner":"aliyun-computenest","RepoName":"aliyun-computenest/java-springboot-demo","Name":"java-springboot-demo"}

Examples

Success response

JSON format

{
  "RequestId": "51004B8A-6D9A-5ACB-9158-6C6794496AD0",
  "Application": {
    "Description": "Application",
    "UpdateDate": "2021-09-07T09:17:46Z",
    "ResourceGroupId": "rg-acfmxsn4m******",
    "Tags": {
      "k1": "v1",
      "k2": "v2"
    },
    "Name": "MyApplication",
    "CreateDate": "2021-09-07T09:17:46Z",
    "ApplicationType": "DingTalk",
    "AlarmConfig": {
      "ContactGroups": [
        "Alert contact group name\n"
      ],
      "TemplateIds": [
        "18ad7c9ddff24d1ba34aa76ec3944507"
      ],
      "HealthCheckUrl": "/api/health/"
    },
    "ServiceId": "service-79538e30e44541b699d8",
    "ApplicationSource": "{\"Platform\":\"gitee\",\"Owner\":\"aliyun-computenest\",\"RepoName\":\"aliyun-computenest/java-springboot-demo\",\"Name\":\"java-springboot-demo\"}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.