Application Observability in CloudMonitor 2.0 Explained - CloudMonitor 2.0 - Alibaba Cloud - Cloud Monitor

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

cms:GetServiceObservability

get

*Workspace

acs:cms:{#regionId}:{#accountId}:workspace/{#workspace}/service-observability/{#type}

None

Request syntax

GET /workspace/{workspace}/service-observability/{type} HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

workspace

string

Yes

The Cloud Monitor 2.0 workspace.

my-test-ws

type

string

Yes

The application observability type.

Valid values:

rum :

Real User Monitoring (RUM).
apm :

Application Performance Monitoring (APM).

apm

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response schema.
requestId	string	The request ID.	4852B9B5-345C-5CBC-A15F-786D83ECCBBA
type	string	The type of application observability. Valid values: rum : RUM apm : APM	apm
regionId	string	The region.	cn-hangzhou
workspace	string	The workspace name.	default-cms-1654218***343050-cn-hangzhou
status	string	The resource initialization status. Valid values: Running : normal	Running
entryPointInfo	object	The endpoint and authentication information.
authToken	string	The authentication token for reporting data.	gaddp**@de20f21ce**
publicDomain	string	The public endpoint.	project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com
privateDomain	string	The internal endpoint.	project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com
project	string	The Simple Log Service project.	proj-xtrace-xxxxx
feeType	string	The billing type.	arms=serverless;xtrace=serverless
settings	object	The system configuration.
	string	The configuration key-value pairs.	{"trace_aggregate":"enable"}
quotas	object	The quota configuration.
	string	The quota configuration key-value pairs.	{"arms_agent_hour": "48"}

Examples

Success response

JSON format

{
  "requestId": "4852B9B5-345C-5CBC-A15F-786D83ECCBBA",
  "type": "apm",
  "regionId": "cn-hangzhou",
  "workspace": "default-cms-1654218***343050-cn-hangzhou",
  "status": "Running",
  "entryPointInfo": {
    "authToken": "gaddp****@de20f2***1ce***",
    "publicDomain": "project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com",
    "privateDomain": "project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com",
    "project": "proj-xtrace-xxxxx"
  },
  "feeType": "arms=serverless;xtrace=serverless",
  "settings": {
    "key": "{\"trace_aggregate\":\"enable\"}"
  },
  "quotas": {
    "key": "{\"arms_agent_hour\": \"48\"}"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.