All Products
Search
Document Center

Microservices Engine:GetLosslessRuleByApp

Last Updated:Nov 20, 2024

Queries the rules for graceful start and shutdown of an application.

Operation description

You can call this operation to query the rules for graceful start and shutdown of an application.

You can query the rules for graceful start and shutdown of an application preferentially by using the AppId parameter.

If the AppId parameter is left empty, you can use the RegionId, Namespace, and AppName parameters to query the rules for graceful start and shutdown of an application.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
mse:GetLosslessRuleByAppget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
AppNamestringNo

The name of the application.

example-app
NamespacestringNo

The name of the MSE namespace.

default
AppIdstringNo

The ID of the application.

hkhon1po62@c3df23522baa***
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The request ID.

DC34E4A3-5F1C-4E40-86EA-02EDF967****
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codeinteger

The response code.

200
ErrorCodestring

The error code returned.

Success
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

success
Dataobject

The data returned.

AppNamestring

The name of the application.

spring-cloud-a
AppIdstring

The ID of the application.

hkhon1po62@24810bf4364a***
Countinteger

The number of instances.

1
Enableboolean

Indicates whether graceful start is enabled. Valid values:

  • true: enabled
  • false: disabled
true
WarmupTimeinteger

The prefetching duration. Unit: seconds.

120
DelayTimeinteger

The registration latency. Unit: seconds.

60
FuncTypeinteger

The slope of the prefetching curve.

2
Alignedboolean

Indicates whether service registration is complete before readiness probe.

true
Relatedboolean

Indicates whether service prefetching is complete before readiness probe.

false
LossLessDetailboolean

Indicates whether online and offline processing details are displayed.

true
Noticeboolean

Indicates whether notification is enabled.

false

Examples

Sample success responses

JSONformat

{
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "Success",
  "HttpStatusCode": 200,
  "Message": "success",
  "Data": {
    "AppName": "spring-cloud-a",
    "AppId": "hkhon1po62@24810bf4364a***",
    "Count": 1,
    "Enable": true,
    "WarmupTime": 120,
    "DelayTime": 60,
    "FuncType": 2,
    "Aligned": true,
    "Related": false,
    "LossLessDetail": true,
    "Notice": false
  }
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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

Change history

Change timeSummary of changesOperation
2023-06-20The Error code has changedView Change Details