GetArmsTopNMetric - Serverless App Engine - Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request and response headers.

Request syntax

GET /pop/v1/sam/getArmsTopNMetric HTTP/1.1

Request parameters

Parameter	Type	Position	Required	Example	Description
RegionId	String	Path	Yes	cn-hangzhou	The region ID.
OrderBy	String	Path	Yes	count	The field based on which you want to sort the returned entries.
Limit	Long	Path	Yes	10	The total number of entries to return. Valid values: 0 to 100.
StartTime	Long	Path	Yes	1675823135951	The beginning of the time range to query.
EndTime	Long	Path	Yes	1675824035951	The end of the time range to query.

Response parameters

Parameter	Type	Example	Description
Message	String	success	The returned message. Valid values: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.
RequestId	String	3B763F98-0BA2-5C23-B6B8-558568D2C1C2	The request ID.
Data	Array of ArmsMetricDto		The applications.
AppId	String	7171a6ca-d1cd-4928-8642-7d5cfe69****	The application ID.
Name	String	test	The application name.
RegionId	String	cn-hangzhou	The namespace ID.
Count	Long	100	The total number of requests.
Error	Long	0	The number of errors.
Rt	Long	100	The average response time. Unit: milliseconds.
Code	String	200	The HTTP status code. Valid values: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.
Success	Boolean	true	Indicates whether the applications were obtained. Valid values: true: The applications were obtained. false: The applications failed to be obtained.

Examples

Sample requests

GET /pop/v1/sam/getArmsTopNMetric HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetArmsTopNMetricResponse>
    <Message>success</Message>
    <RequestId>3B763F98-0BA2-5C23-B6B8-558568D2C1C2</RequestId>
    <Data>
        <AppId>7171a6ca-d1cd-4928-8642-7d5cfe69****</AppId>
        <Name>test</Name>
        <RegionId>cn-hangzhou</RegionId>
        <Count>100</Count>
        <Error>0</Error>
        <Rt>100</Rt>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</GetArmsTopNMetricResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "3B763F98-0BA2-5C23-B6B8-558568D2C1C2",
  "Data" : [ {
    "AppId" : "7171a6ca-d1cd-4928-8642-7d5cfe69****",
    "Name" : "test",
    "RegionId" : "cn-hangzhou",
    "Count" : 100,
    "Error" : 0,
    "Rt" : 100
  } ],
  "Code" : "200",
  "Success" : true
}

Error codes

HttpCode	Error code	Error message	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	The value of the %s parameter is invalid. This parameter cannot be left empty.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	The value of the {%s} parameter is invalid.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s	The value %s of the {%s} parameter is invalid.

For a list of error codes, see Service error codes.