GetServiceObservability - Cloud Monitor - Centro de documentación de Alibaba Cloud

Obtiene la instancia de observabilidad de aplicaciones.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

cms:GetServiceObservability

get

*Workspace

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

Ninguna

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
workspace	string	Sí	El espacio de trabajo de CMS 2.0.	my-test-ws
type	string	Sí	El tipo de observabilidad de aplicaciones. Valores válidos: rum : Monitoreo de usuarios reales. apm : Monitoreo de rendimiento de aplicaciones.	apm

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
requestId	string	El ID de la solicitud.	4852B9B5-345C-5CBC-A15F-786D83ECCBBA
type	string	El tipo de observabilidad de aplicaciones. Valores válidos: rum : rum. apm : apm.	apm
regionId	string	La región.	cn-hangzhou
workspace	string	El nombre del espacio de trabajo.	default-cms-1654218***343050-cn-hangzhou
status	string	El estado de inicialización del recurso. Valores válidos: Running : Normal.	Running
entryPointInfo	object	La información del endpoint y de autenticación.
authToken	string	El token de autenticación para el reporte de datos.	gaddp**@de20f21ce**
publicDomain	string	La dirección de acceso a la red pública.	project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com
privateDomain	string	La dirección de acceso interno.	project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com
project	string	Proyecto de SLS.	proj-xtrace-xxxxx
feeType	string	El tipo de facturación.	arms=serverless;xtrace=serverless
settings	object	Las configuraciones del sistema.
	string	Los pares clave-valor de configuración.	{"trace_aggregate":"enable"}
quotas	object	Las configuraciones de cuota.
	string	La clave del elemento de configuración de cuota.	{"arms_agent_hour": "48"}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "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\"}"
  }
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.