All Products
Search
Document Center

Application Real-Time Monitoring Service:GetAppApiByPage

Last Updated:May 09, 2024

Queries the API operations of application monitoring by page.

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
arms:GetAppApiPageInfoWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region.

cn-hangzhou
StartTimelongYes

The beginning of the time range to query. Unit: milliseconds.

1600063200000
EndTimelongYes

The end of the time range to query. Unit: milliseconds.

1600066800000
CurrentPageintegerYes

The page number of the returned page.

1
PageSizeintegerNo

The number of entries to return on each page. This parameter is no longer supported. The number of entries to return on each page. Default value: 10.

10
IntervalMillsintegerNo

The time interval between the data shards to be queried. Unit: milliseconds. Minimum value: 60000. Maximum value: 2147483647.

60000
PIdstringYes

The process identifier (PID) of the application. For information about how to obtain a PID, see Obtain the PID of an application.

a2n80plglh@745eddxxx

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code returned for the request. Valid values:

  • 2XX: The request was successful.
  • 3XX: A redirection message was returned.
  • 4XX: The request was invalid.
  • 5XX: A server error occurred.
200
Messagestring

The message returned.

message
RequestIdstring

The ID of the request.

B6A00968-82A8-4F14-9D1B-B53827DB****
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
true
Dataobject

The struct returned.

PageSizeinteger

The number of entries returned per page.

10
Totalstring

The total number of returned entries.

0
Pageinteger

The page number of the returned page.

1
Completedboolean

Is completed.

false
Itemsobject []

The data entries.

object

The data entries returned.

[]

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "message",
  "RequestId": "B6A00968-82A8-4F14-9D1B-B53827DB****",
  "Success": true,
  "Data": {
    "PageSize": 10,
    "Total": "0",
    "Page": 1,
    "Completed": false,
    "Items": [
      []
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-01-25The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400
    Added Error Codes: 404
    Added Error Codes: 500
2023-06-09The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.