All Products
Search
Document Center

CloudOps Orchestration Service:GetApplication

Last Updated:Oct 14, 2024

Queries the information of an application. You can call this operation only for the applications that reside in the China (Hangzhou) region. Use an endpoint of the China (Hangzhou) region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oos:GetApplicationget
  • Application
    acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID. Set the value to cn-hangzhou.

cn-hangzhou
NamestringYes

The application name.

MyApplication

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

51004B8A-6D9A-5ACB-9158-6C6794496AD0
Applicationobject

The information about the application.

Descriptionstring

The description of the application.

Application
UpdateDatestring

The time when the application was updated.

2021-09-07T09:17:46Z
ResourceGroupIdstring

The ID of the resource group.

rg-acfmxsn4m******
Tagsobject

The tags.

{"k1": "v1", "k2": "v2"}
Namestring

The application name.

MyApplication
CreateDatestring

The time when the application was created.

2021-09-07T09:17:46Z
ApplicationTypestring

The type of the application.

Valid values:

  • ComputeNest

  • Custom

  • DingTalk

DingTalk
AlarmConfigobject

The configurations of application alerts.

ContactGroupsarray

The alert contact list.

ContactGroupstring

The alert contact group.

group_name
TemplateIdsarray

The ID of the alert template.

TemplateIdstring

The ID of the alert template.

18ad7c9ddff24d1ba34aa76ec3944507
HealthCheckUrlstring

The health check URL of the application.

/api/health/
ServiceIdstring

The ID of the service.

service-79538e30e44541b699d8

Examples

Sample success responses

JSONformat

{
  "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": [
        "group_name"
      ],
      "TemplateIds": [
        "18ad7c9ddff24d1ba34aa76ec3944507"
      ],
      "HealthCheckUrl": "/api/health/"
    },
    "ServiceId": "service-79538e30e44541b699d8"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-12The response structure of the API has changedView Change Details
2023-07-27The response structure of the API has changedView Change Details
2023-07-18The response structure of the API has changedView Change Details