GetServiceObservability - Cloud Monitor: Central de Documentação do Alibaba Cloud

Obtém a instância de observabilidade de aplicações.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cms:GetServiceObservability

get

*Workspace

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

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
workspace	string	Sim	O workspace do CMS 2.0.	my-test-ws
type	string	Sim	O tipo de observabilidade de aplicações. Valores válidos: rum : Monitoramento de usuários reais. apm : Monitoramento de desempenho de aplicações.	apm

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
requestId	string	O ID da solicitação.	4852B9B5-345C-5CBC-A15F-786D83ECCBBA
type	string	O tipo de observabilidade de aplicações. Valores válidos: rum : rum. apm : apm.	apm
regionId	string	A região.	cn-hangzhou
workspace	string	O nome do workspace.	default-cms-1654218***343050-cn-hangzhou
status	string	O status de inicialização do recurso. Valores válidos: Running : Normal.	Running
entryPointInfo	object	O endpoint e as informações de autenticação.
authToken	string	O token de autenticação para reporte de dados.	gaddp**@de20f21ce**
publicDomain	string	O endereço de acesso à rede pública.	project-xtrace-xxxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com
privateDomain	string	O endereço de acesso interno.	project-xtrace-xxxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com
project	string	Projeto do SLS.	proj-xtrace-xxxxx
feeType	string	O tipo de cobrança.	arms=serverless;xtrace=serverless
settings	object	As configurações do sistema.
	string	Os pares chave-valor de configuração.	{"trace_aggregate":"enable"}
quotas	object	As configurações de cota.
	string	A chave do item de configuração de cota.	{"arms_agent_hour": "48"}

Exemplos

Resposta de sucesso

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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.