All Products
Search
Document Center

Elastic High Performance Computing:ListCloudMetricProfilings

Last Updated:Apr 09, 2024

Queries the profiling information of a specified cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:ListCloudMetricProfilingsREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
ClusterIdstringYes

The ID of the cluster.

ehpc-hz-FYUr32****
PageNumberintegerNo

The page number of the page to return.

Pages start from page 1.

Default value: 1

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 50

Default value: 10

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries that are returned per page.

1
RequestIdstring

The ID of the request.

9A05F620-ED46-4A57-95F1-C67D6D3C5DD2
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries.

1
Profilingsobject []

The profiling information of a specified cluster.

ProfilingIdstring

The ID of the profiling process.

ehpc-hz-i-bplukzqgl****_21687_2019-09-09-02-37-40
TriggerTimestring

The time when the profiling process is triggered.

2019-09-09 02:37:40
Pidinteger

The ID of the profiling process.

21687
HostNamestring

The name of the host.

compute5
Durationinteger

The duration of the profiling process. Unit: seconds

Valid values: 10 to 300

30
InstanceIdstring

The ID of the node.

i-bp1j76z8dlukzqgl0****
Freqinteger

The frequency of the profiling process. Unit: Hz

Valid values: 1 to 2000

2000

Examples

Sample success responses

JSONformat

{
  "PageSize": 1,
  "RequestId": "9A05F620-ED46-4A57-95F1-C67D6D3C5DD2",
  "PageNumber": 1,
  "TotalCount": 1,
  "Profilings": {
    "ProfilingInfo": [
      {
        "ProfilingId": "ehpc-hz-i-bplukzqgl****_21687_2019-09-09-02-37-40",
        "TriggerTime": "2019-09-09 02:37:40",
        "Pid": 21687,
        "HostName": "compute5",
        "Duration": 30,
        "InstanceId": "i-bp1j76z8dlukzqgl0****",
        "Freq": 2000
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParamsInvalid param: %s-
400NotEnabledYou have not enabled this service
400InDebtYour account has overdue payments.
403InvalidClusterStatusThe cluster status does not support the operation.
403ConflictOptA conflicting operation is running. Please try again later.
404ClusterNotFoundThe specified instance does not exist.
404ObjectNotFoundThe specified object does not exist. Please verify the parameter.
407NotAuthorizedThe request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.