Query Logs by Request ID for Precise Filtering with GetCommonLogDetail-E - HPC - Alibaba Cloud - Elastic High Performance Computing

Queries detailed logs by request ID. The logs are organized in a three-layer Action-Stage-Method structure that lists the detailed steps involved in each operation.

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

ehpc:GetCommonLogDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
From	integer	Yes	The beginning of the time range to query. Specify a UNIX timestamp in seconds.	1703821542
To	integer	Yes	The end of the time range to query. Specify a UNIX timestamp in seconds.	1703821666
LogRequestId	string	Yes	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
HiddenProcess	boolean	No	Whether to hide the process details of each step. Valid values: true: returns only the result log of each step. false: returns the start and result logs of each step. Default value: true.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	464E9919-D04F-4D1D-B375-15989492****
Uid	string	The ID of the Alibaba Cloud account.	137***
OperatorUid	string	The account ID of the operator.	239***
Action	string	The action name.	CreateCluster
ClusterId	string	The cluster ID.	ehpc-hz-abc***
LogType	string	The log type.	operation
LogDetail	array<object>	The log entries.
	array<object>	The log entry details.
StageName	string	The stage name of the log.	ConfigNetwork
Stages	array<object>	The log stages.
	object	The log stage details.
RequestId	string	The request ID associated with the log.	04F0F334-1335-436C-A1D7-6C044FE7****
Time	string	The time when the log was generated.	2024-08-22 14:21:54
Method	string	The method name.	CreateSecurityGroup
Status	string	The action status. Valid values: InProgress: The action is in progress. Finished: The action is completed. Failed: The action failed.	Finished
LogLevel	string	The log level. Valid values: ERROR INFO WARN Valid values: ERROR : error INFO : info WARN : 警告	INFO
Target	string	The target resource.	sg-bcd***
Message	string	The log message.	Successfully created security group sg-bcd***

Examples

Success response

JSON format

{
  "RequestId": "464E9919-D04F-4D1D-B375-15989492****\n",
  "Uid": "137***",
  "OperatorUid": "239***",
  "Action": "CreateCluster",
  "ClusterId": "ehpc-hz-abc***",
  "LogType": "operation",
  "LogDetail": [
    {
      "StageName": "ConfigNetwork",
      "Stages": [
        {
          "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
          "Time": "2024-08-22 14:21:54\n",
          "Method": "CreateSecurityGroup",
          "Status": "Finished",
          "LogLevel": "INFO",
          "Target": "sg-bcd***",
          "Message": "Successfully created security group sg-bcd***"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.