Obter o RequestId de uma solicitação de API - OpenAPI Explorer: Central de Documentação do Alibaba Cloud

A Alibaba Cloud atribui um RequestId exclusivo a cada solicitação de API. Use o RequestId para diagnosticar erros no OpenAPI Troubleshoot ou auditar chamadas no ActionTrail.

Métodos

Recupere o RequestId na resposta da API de diversas formas, conforme o fluxo de trabalho:

Operações no console: Use as ferramentas de desenvolvedor do navegador.
Depuração de API: Use o OpenAPI Explorer.
Integração de código: Use um SDK da Alibaba Cloud.
Operações em linha de comando: Use o Alibaba Cloud CLI.
Infraestrutura como código: Use o Terraform. O RequestId é uma string no formato UUID, como EB2D2E3C-DE2D-5ABD-8F40-7FA3E6D31AF4. A presença desse campo na resposta confirma a recuperação do RequestId, que aparece tanto em respostas de sucesso quanto de erro. Caso uma solicitação retorne um erro, insira o RequestId no OpenAPI Troubleshoot para obter diagnóstico e solução. Para erros de permissão, também é possível obter a ação não autorizada específica (AuthAction) e a mensagem de diagnóstico criptografada relacionada (EncodedDiagnosticMessage) no campo AccessDeniedDetail da resposta de erro.

Usar ferramentas de desenvolvedor do navegador no console

Ao executar operações no console, abra as ferramentas de desenvolvedor do navegador (F12) e filtre por api.json? para visualizar o RequestId de uma solicitação.

Por exemplo, quando um usuário RAM sem permissões suficientes aciona um erro Forbidden.RAM, o console exibe uma caixa de diálogo Access Denied com campos como Error code, Request ID, Action e Identity principal type. Filtre pela solicitação api.json?action=ModifySecurityGroupAttribute no painel de rede. A resposta JSON mostra o requestId correspondente e os detalhes do erro em accessDeniedDetail, incluindo os campos AuthAction, AuthPrincipalType, NoPermissionType e PolicyType.

Usar o OpenAPI Explorer

Ao depurar uma API no OpenAPI Explorer, o RequestId da solicitação aparece no resultado da chamada.

A resposta JSON da chamada também contém os seguintes campos principais:

HostId: O endpoint do service cloud que processou a solicitação, como ecs-cn-hangzhou.aliyuncs.com.
Code: O código de erro. Por exemplo, Forbidden.RAM indica que o usuário RAM não tem autorização para operar no recurso especificado.
Message: A mensagem de erro que descreve a causa da falha.
Recommend: Uma URL para a página do OpenAPI Troubleshoot referente ao código de erro. Abra a URL para visualizar informações de diagnóstico e soluções.
AccessDeniedDetail: Os detalhes da negação de permissão, incluindo subcampos importantes como AuthAction, AuthPrincipalType e EncodedDiagnosticMessage.

Usar SDKs

Ao usar um SDK da Alibaba Cloud, obtenha o RequestId diretamente da resposta da API. Se ocorrer um erro, capture a exceção correspondente para obter as informações de erro, incluindo o RequestId.

try {
    ModifySecurityGroupAttributeRequest modifySecurityGroupAttributeRequest = new ModifySecurityGroupAttributeRequest()
        .setRegionId("cn-chengdu")
        .setSecurityGroupId("sg-2xxx")
        .setDescription("only test");
    ModifySecurityGroupAttributeResponse response = client.modifySecurityGroupAttributeWithOptions(modifySecurityGroupAttributeRequest, runtimeOptions);
    System.out.println(new Gson().toJson(response));
} catch (Exception e) {
    if (e instanceof TeaException) {
        TeaException teaException = (TeaException) e;
        System.err.println("Request ID: " + teaException.getRequestId());
        System.err.println("Error Code: " + teaException.getCode());
        System.err.println("Error Message: " + teaException.getMessage());
        System.err.println("Error Data: " + teaException.getData());
        throw new RuntimeException("API call failed", teaException);
    } else {
        System.err.println("Unexpected error occurred: " + e.getMessage());
        throw new RuntimeException("Unexpected error", e);
    }
}

O método getRequestId() no objeto de exceção retorna o RequestId diretamente. Você também pode encontrar o RequestId na saída de erro:

Error Code: Forbidden.RAM
Error Message: code: 403, User not authorized to operate on the specified resource, or this API doesn't support RAM. request id: EB2D2E3C-DE2D-5ABD-8F40-7FA3E6D31AF4
Error Data: {RequestId=EB2D2E3C-DE2D-5ABD-8F40-7FA3E6D31AF4, HostId=ecs-cn-hangzhou.aliyuncs.com, Code=Forbidden.RAM, Message=User not authorized to operate on the specified resource, or this API doesn't support RAM., Recommend=https://api.alibabacloud.com/troubleshoot?q=Forbidden.RAM&product=Ecs&requestId=EB2D2E3C-DE2D-5ABD-8F40-7FA3E6D31AF4, AccessDeniedDetail={PolicyType=ResourceGroupLevelIdentityBasedPolicy, AuthPrincipalOwnerId=1xxx6, EncodedDiagnosticMessage=AQIBIAAAAH13IrZA790Zkpi90wMZV/djLrVZYZ095+ad/t9KTHUamUspajhw3fLk2bPC33jhm9N7YhLxJBLwB4TzYmXq/afb6N916JVS3yCOw+TECTGjZr4QglIZsFA+h+ReEbwG+LpVFh12zZJrS8kkCW+8VNSLM1cfBKkNon9hAUyA5WK3ONRSCPFoDPplynjQ3qsYUTdtXHgsAxIEOZa6xCr+e56B0wmhm3x3ZjcRznY1D8u0Yfwn0cPf1oLFC4F1A1B2UeJBxzhn2t7s8NTAYcNBZp03zLu8VuL6gkAwJyZSEabaXs1bhidwZDrTc/JkToX/0AhHh0b8j/qqTZ6K9KtcZ7PJT0bESMPjXxezm4fr0CvozoHb9zAcyZkoRg1XkJfV9bcxvoWPaRcOdbyQSHMbRV089VUY4h8Cb5L8IblQt8TKREwrJJijrF80HfFiAfYORLQWCptgA/LeTZJisebTTNNcwmhdOy23NhFFWORjL9t4uhygqRWZqgwLb7FZMenr9PiTP4xVYcYELs/fsHKAbnIcn+XAKjaucIxqFucbmMLi1fuaeYJa0YY7FyAuxyuiCRwFHMtCRj191R1R2FSin3OXfsPd0K1u30m1Zi10XTaOmn69mScRe/NYGw5WW+pC/y7itJyLztHZp+S2o9kTEH6e1kNSV4FwsSwf4/+SKWa}}

Usar o Alibaba Cloud CLI

Ao usar o Alibaba Cloud CLI, o RequestId aparece na saída do CLI.

shell@Alicloud:~$ aliyun ecs ModifySecurityGroupAttribute --region cn-chengdu --RegionId 'cn-chengdu' --SecurityGroupId 'sg-2xxx' --Description 'test sg'
ERROR: SDK.ServerError
ErrorCode: Forbidden.RAM
Recommend: https://api.alibabacloud.com/troubleshoot?q=Forbidden.RAM&product=Ecs&requestId=9F1F4997-A1E7-5B35-A5B7-7D668F4F4A51
RequestId: 9F1F4997-A1E7-5B35-A5B7-7D668F4F4A51
Message: User not authorized to operate on the specified resource, or this API doesn't support RAM.
RespHeaders: map[Access-Control-Allow-Origin:[*] Access-Control-Expose-Headers:[*] Connection:[keep-alive] Content-Length:[1898] Content-Type:[applica
tion/json;charset=utf-8] Date:[Mon, 22 Sep 2025 06:09:05 GMT] Keep-Alive:[timeout=25] Vary:[Accept-Encoding] X-Acs-Request-Id:[9F1F4997-A1E7-5B35-A5B7
-7D668F4F4A51] X-Acs-Trace-Id:[06140130ef99e54579652c9ced2e0a79]]
AccessDeniedDetail: map[AuthAction:ecs:ModifySecurityGroupAttribute AuthPrincipalDisplayName:2xxx    4 AuthPrincipalOwnerId:14xxx      6
AuthPrincipalType:SubUser EncodedDiagnosticMessage:AQIBIAAAAHuT4vB154DXED4KADE6tXWFYoyd8scM82aU3wC8JzzunFbX8kwIN/xENJ1WATBDNUtY78L36rFULZW8rdyVWUFz
bCH7x5h2xWFfHyDPKCdt2ZHzedv7omxldyK4Km22h0MbxxlWXee5VCd3nbBSB53GWs/DQ8R20fUcTs7nBQ6qq/LC/0PMtqwPnuQFr1s92ZrwXX6LoooqJtq7V5BsIgnUItjqqc6x4m6xZLr9PHEVDnN
RfLOWKPNq+tUEDgsamChTuvV/JZqwxsszCt7KShc9igo0UNfdH3mhO6Fr9w9ohG0YNcpjyiUJeWvNkOmHrXPznbSFmCqNLDeOtGevBy8iMyha/gRG8G9HBHc6pRJBhI1i9qq4tSR6R2DkWZBG7MhPLGfey6
dbEyRlMhvrpT1HODx+3JMJY0gyQ6li9XtKuttioWKkXV4LVANK6sx0U5I1BJUOJCFaPstPOxBk8x8zUEdAQxkgpQ1M9zrw/HAZlaIzwp/r969SryaKEwSkUsVUbcMyr8Y23ertzD16I185p998eOSLM
Y4q1Lnc9d5zxuuRh12eHWZSGNczpAGRY7qpYAYuPnWQ0/Mi0HfBbb5+pf1obhd5hml5TShcDbhMhy2j/GtoBoh/9KPpv57rk7baub0C/FRRs/CeKUciG0KtBTO1oTx6YHiv/vTOuSbBzAzh+Njrg+HoPS
c1iE9jgymUB4YGr7QoMay0BBD8CkPIvj7j3xNLeNlKNKNlAnxGtB4KXlA2OZqxolWXlavWPmVDzYP80Ux8R+uPbBhG+oZhJblWQ62igP8bkBtt83ifGSPtVQq5D7/U4w1DHjBAKS3YOPsvGtJBUbNNs
jSZUALRBeLe+0SQIud/mTPXIMkP6DiPa6nIObsWi0c8Na3nTVsYcsWpMtsXiX4SXmmtVGo9Xh3ti/+v/Aou6X9FuG+J67D/sD73D1ifAoDx2yWdA5W1/7BqCtWr1l01lJs5W51gyNd36SCnwLQHfmht
NLiaZOv4U7VUB1G31mR0fMVVC29VQ6Yq/QjtSZI3HQwILWlrzSE+4ShbqdJrOT2ifDma4CJWmj274NsaxzCpTc/nlExiWhn1nHMJVQ7OtssRCsrEcxyaknzqMZBLWDdOWJ1j9JWJ+HtaKZXPjLU+03
GJ5JZ4o97YutOwBtPi4Q9A4b0v+nCahKPLbOHLtGSeJOVnxFk1PIQGK/h6a6dabJPF8XXwNww9hJsgcK2+huCjsB1NcDq7/uI= NoPermissionType:ImplicitDeny PolicyType:ResourceG
roupLevelIdentityBasedPolicy]
shell@Alicloud:~$

Usar o Terraform

Como o Terraform orquestra múltiplos recursos, ele não imprime o RequestId em execuções bem-sucedidas. No entanto, se ocorrer um erro durante a execução, a saída de erro incluirá o RequestId.

Error: [ERROR] terraform-provider-alicloud/alicloud/resource_alicloud_security_group_rule.go:209:
SDK.ServerError
ErrorCode: Forbidden.RAM
Recommend: https://api.alibabacloud.com/troubleshoot?q=Forbidden.RAM&product=Ecs&requestId=F7A01BD7-5771-544D-A80F-CD290806BBFA
RequestId: F7A01BD7-5771-544D-A80F-CD290806BBFA
Message: User not authorized to operate on the specified resource, or this API doesn't support RAM.
RespHeaders: map[Access-Control-Allow-Origin:[*] Access-Control-Expose-Headers:[*] Connection:[keep-alive] Content-Type:[application/json;charset=utf-8] Date:[Mon, 22 Sep 2025 06:28:49 GMT] Keep-Alive:[timeout=25] Vary:[Accept-Encoding Accept-Encoding] X-Acs-Request-Id:[F7A01BD7-5771-544D-A80F-CD290806BBFA] X-Acs-Trace-Id:[56259f4ddd3121273aedd3539554b295]]
AccessDeniedDetail: map[AuthAction:ecs:DescribeSecurityGroupAttribute AuthPrincipalDisplayName:2                    ]44 AuthPrincipalOwnerId:1      1
6 AuthPrincipalType:SubUser EncodedDiagnosticMessage:AQIBIAAAAMAMz25m9UV+V73fYm+VwVpWAWalMx3dMLYLsDdvHje27uM8nS3Cfm+foIiXEIK+O0WPs41Aaw6QjwBXBjhN7c+N1A
g2FtPaTVWqa8gcqjDQUMO2nzu2orWnfdi12kFfrOZTOQQ1HU97svdvaB+dqur96J8MycNt5UBfp2Afq2H2loKzgNKftodLq6Bcpvxpax76L2MwQD2WpInUU/7i2DfrsI29NehSsDorBmnB+/z9Vjx
l19FZ2yUYQmj/Mbzdsn8aOxkeNwggYEJHnwEgNc9ZcklkEONxzthR/g/plHkRwCjWFjTpUm4i09ss/hMcQW4Z7OiubloCS93JtdP1A1IMTwSD7z5/hjWRHVa1Ud00hI73Sg+iZEb0gaf970xSQ
k+Bdzu7+RXMsP0LYd9VDjmShlTT5Mw65yGPeYKFLA/iweIaeMiBf4LoVorY+3RYZglqW2qEcHVdhb8tLDMMp0/7KRiLAOpKyYb4tCyVUaOC9E14Xda0UxJNBGVKJFCZwaHK9q2p0Yu6MrJkDB2g3kx
mt54nm9e5W1gnm/Ub4tqeOCrte6JOWkFNQyW8tscoxon/aeYBB1pxsf+Mj1Ah2gNQ2/7DjOeZvR8IgNIN9gj5asSy1XxyevVjcS+EJYdX8OWeuIq93kPItw/+u9CGIJVNcl1vMJaBIrJ1fqf+/z0QN
Z5Ivd5gr4VwUGk7bghwkzNCArirvMfsgGrSa7UHRtjooNdwteFAuxH92UPpiaqhx0/uf3n3Hn3AKLQWsnRZtBsapDv4KQP0Qe/r0WXWAgz2/4dBckU5LItHaOEjB8qFmfH8xoHh7infBnfe7injUafTkT
X1wfv1g+0PTTEmpb8xNAd7rY2LTZ/mzAxUOWKmst6KmgXyAMLBrkyw2q+FkmnTBnCf3P9G6l7yfj2jI/OSUULdIC1RkdVocxALi1IHXOEP8IA41L2nV+IWBh38OOzXXP2E7y7+sT9miDxiwrbatbrL
UGkTCMcNAtBD84Xg7QKuzi7Kxev9uuOq36DLOSObzbfMzurts2Kxivq3syaIVVxVaI1gSz2OhEiov3qC5MWOhAWqHdzJVVwJX3zeYwp54XH5IGBnjDi3Fqi1DcD7hw/Ga/5JsSUrLC8hcOu3ahdPvfq
66TTX+k07FgWKTyScGf1ybj2XZnTus9dwcWbKYK3muAxb5vQnYGoP6LLMj5biUZToDKd8yVsZDRguiSurCD/ONULjA511JdM3Z4= NoPermissionType:ImplicitDeny PolicyType:Resource
eGroupLevelIdentityBasedPolicy]

Usar Signature V3 diretamente

Se você chamar uma API usando Signature V3 em vez de um SDK, a resposta de erro conterá o RequestId no corpo JSON.

O código de exemplo Java a seguir chama a operação ModifySecurityGroupAttribute do ECS usando Signature V3:

private static final String ALGORITHM = "ACS3-HMAC-SHA256";
public static void main(String[] args) {
    String httpMethod = "POST";
    String canonicalUri = "/";
    String host = "ecs.cn-chengdu.aliyuncs.com";
    String xAcsAction = "ModifySecurityGroupAttribute";
    String xAcsVersion = "2014-05-26";
    SignatureRequest signatureRequest = new SignatureRequest(httpMethod, canonicalUri, host, xAcsAction, xAcsVersion);
    signatureRequest.queryParam.put("SecurityGroupId", "sg-2vxxx");
    signatureRequest.queryParam.put("Description", "test sg");
    signatureRequest.queryParam.put("RegionId", "cn-chengdu");
}

A chamada retorna um erro Forbidden.RAM. Use o RequestId E172420D-62F4-5B54-879B-6926F779ED38 para solucionar o problema. Veja abaixo a saída completa do console:

authorization========>ACS3-HMAC-SHA256 Credential=LTAxxx                    ,SignedHeaders=host;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version,Signature=fd3ba03422d195df95992f351cbe8bdc73de34cee61c6d94e1cf720406cfdbe4
V3 signature invoke result:
{"RequestId":"E172420D-62F4-5B54-879B-6926F779ED38","HostId":"ecs.cn-chengdu.aliyuncs.com","Code":"Forbidden.RAM","Message":"User not authorized to operate on the specified resource, or this API doesn't support RAM.","Recommend":"https://api.alibabacloud.com/troubleshoot?q=Forbidden.RAM&product=Ecs&requestId=E172420D-62F4-5B54-879B-6926F779ED38","AccessDeniedDetail":{"PolicyType":"ResourceGroupLevelIdentityBasedPolicy","AuthPrincipalOwnerId":"1xxx","EncodedDiagnosticMessage":"AQBIAAAAAQBSngosi X6fJmgifT84XorhK4BRg2Sou2s7OrXC9gig3UsY8fkC1px/q5sZZaE8SQv+FJtVx+ltT8dX11y2rIqnsfTIQtXqtCN3oFWFzs2TVg64/YnzemB0e/r4zyRuGT98DajQhDtfv2J/ua9WmgLpdv90n5OA4hctr/zabwYW1VokhLwLWfCvmYm6Q/A2/9hXf9EVSxqASL09qyAdafRBw6WTWOYh6o0+sJK6Cd17eXYJUEwKRtdXY8he0nXCO0SKzgghrhm/Qc58JqryqdgZ66RXqRKDK3oippMDc+4bQzkUEsOw1QPjmDGEsTWUC9eHtkRSgcMtVotMUzjViB30I2M5x5bRANHRHKCAzn0gA2vxMo9y+Dvyc8o6GdRo2x51kzZh/0Ij2Vio9KtbSUr2qpFyo4Fi+5Z/pLGPen9ucKAVBTKb5FS1znrbiuFsoK5izdz27SwRTjngwO/WmOdficf0OtRkVfEmrERkZX4k20WYeL0Ze62L+yD35c0y6Uof4pUb4+hMw870k3f3OZq4ffAT3eQW7G6qRxrKNzd9mBWUU/wESttsX2/FI//A1FP/FV40dvmvKJnUH/gNwxPTbiz5tzhMHM0LM0iq3V1xM9U/N/6ifZMfN11e8
+k3JZkg0ij9yraOgy3kR2RBNQbRewV7euGsWk8G3KCCKEhBgo6GkadmFf7tLA5vUkfBUnxaU0ZwWb3oy19KssITAtdwVbJ7VajFn9dN8zirz TfFYXx58jgu93tW0196EeKhG9epxtE6PdkTVtXLJQSQoNMYKbS4oMvtI9D/6IkoNABkfQ6jGT89EnPzsdYWpomamsSVLy3tkIU29AIMuc1bMTKAwtfrcyweIK0mcu6GUVqd+JANGe2OV7v3rMLvaQ2Oi6+5avOF7ddnLg82iNSwtyyriXPO0djRdSAEs6o0PUtSc/8tU0WHEsfLxZM4+6CNABN9O6GpPeo5/7m6ft75FS+XRgAqdPxJvAm9QO8mnIwCRymTqGO5Sdnx1hg6vOuDf1wvxDQ2T2HqU4RPB4mdyWTRLQrJhrBhVxN2UkhS3MFqvIczKx+t4gZQ7o7xYaWe365DaeI6I+5mdmvYRvaD+HXixY+wDbUHLJ9MEHBOprfmBD76K+9WgPELYDtjmt3dGV4jaXuLmTX0e+9/LUBBvIqu84MPUA+FZlR4fXsRXxbtA+c9WDFJ3MkOZcTORU9ZkokpksF6h2e1AjXXLNDA1pNQrkfvHdvVHwgc=","AuthPrincipalType":"SubUser","AuthPrincipalDisplayName":"2xxx4","NoPermissionType":"ImplicitDeny","AuthAction":"ecs:ModifySecurityGroupAttribute"}}

Diagnosticar erros com um RequestId

OpenAPI Troubleshoot

Insira um RequestId na página para consultar a cadeia de chamadas, informações básicas, informações de autenticação e conteúdo da resposta da solicitação. Se a solicitação retornou um erro, o resultado do diagnóstico também incluirá uma solução.

Caso uma solicitação seja negada devido a permissões RAM insuficientes, obtenha o parâmetro EncodedDiagnosticMessage da resposta de erro e chame a operação DecodeDiagnosticMessage para decodificar a mensagem de diagnóstico de permissão.

Para erros de permissão RAM insuficiente, a aba Solution exibe o código de erro (como Forbidden.RAM), a mensagem de erro e o resultado do diagnóstico de permissão. Esse resultado inclui a identidade que fez a chamada, a ação que requer autorização e as políticas de sistema recomendadas. A aba Log Information apresenta uma análise visual da cadeia de chamadas, desde o endereço IP do chamador, passando pelo UserAgent e pelo endpoint, até o service cloud de destino, juntamente com o código de status HTTP.

ActionTrail

Chame a operação LookupEvents com um RequestId para consultar os detalhes de um evento. Ao chamar essa operação de API, defina os seguintes valores em LookupAttribute:

Parâmetro	Descrição
Key	Defina como EventId.
Value	O RequestId real.

Execute a operação no Alibaba Cloud API Workbench e configure o endereço do service para a região de destino, como China (Chengdu). Após o sucesso da chamada (código de status 200), o array Events no corpo da resposta JSON retornada conterá os detalhes do evento. O campo AccessDeniedDetail de responseElements contém informações de diagnóstico como PolicyType, AuthPrincipalOwnerId e EncodedDiagnosticMessage. Use essas informações para solucionar a causa da negação de permissão.