Query Canary Release Rule Details via DescribeGreyTagRoute - SAE - Alibaba Cloud - Serverless App Engine

Gets a canary release rule by rule ID.

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

sae:DescribeGreyTagRoute

get

*All Resource

*

None

Request syntax

GET /pop/v1/sam/tagroute/greyTagRoute HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
GreyTagRouteId	integer	Yes	The ID of the rule.	1

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	9D29CBD0-45D3-410B-9826-52F86F90****
Message	string	The message that indicates the result of the call.	success
TraceId	string	The trace ID for querying the details of a call.	0a98a02315955564772843261e****
Data	object	The details of the canary rule.
GreyTagRouteId	integer	The globally unique ID of the canary rule.	16
Name	string	The name of the canary rule.	rule-name
Description	string	The description of the canary rule.	test
ScRules	array<object>	The canary rules for the Spring Cloud application.
	array<object>	An object that defines a canary rule.
path	string	The path to which the rule applies.	/path
condition	string	The relationship between the conditions in the rule. Valid values: AND: All conditions must be met. OR: At least one condition must be met.	OR
items	array<object>	The list of conditions.
	object	An object that defines a single condition.
type	string	The type of request element to match against. Valid values: param: A request parameter. cookie: A cookie. header: A request header.	cookie
name	string	The name of the element to match, as specified by the type parameter. For example, a header name or cookie name.	test
operator	string	The matching operator. Valid values: rawvalue: Performs a direct comparison. list: Matches against an allowlist of values. mod: Calculates the remainder of a division by 100. deterministic_proportional_steaming_division: Performs a percentage-based match.	rawvalue
value	string	The value to match. This value is compared with the actual value of the element specified by type and name.	test
cond	string	The comparison operator. Valid values are >, <, >=, <=, ==, and !=.	==
index	integer	Not used in Spring Cloud applications.	N/A
expr	string	Not used in Spring Cloud applications.	N/A
AlbRules	array<object>	The canary rules for the Application Load Balancer (ALB) instance.
	array<object>	An object that defines a canary rule for an ALB instance.
serviceId	string	The routing service ID.	22
ingressId	string	The ID of the Ingress.	23
condition	string	The relationship between the conditions in the canary rule. Only AND is supported, which indicates that all conditions must be met.	AND
items	array<object>	The list of conditions.
	object	An object that defines a single condition.
type	string	The type of request element to match against. Valid values: sourceIp: The source IP address. cookie: A cookie. header: A request header.	cookie
name	string	The name of the element to match, such as a header or cookie name. This parameter is not used if type is set to sourceIp.	example
operator	string	The matching operator. Only rawvalue is supported, which indicates a direct comparison.	rawvalue
value	string	The value to match. This value is compared with the actual value of the element specified by type and name.	test
cond	string	Currently supports ==.	==
index	integer	Not required for ALB applications.	N/A
expr	string	Not required for ALB applications.	N/A
DubboRules	array<object>	The canary rules for the Dubbo service.
	array<object>	An object that defines a canary rule.
serviceName	string	The Dubbo service name.	com.alibaba.edas.boot.EchoService
group	string	The service group to which the canary rule applies.	DUBBO
version	string	The Dubbo service version.	1.0.0
methodName	string	The method name of the Dubbo service.	echo
condition	string	The relationship between the conditions in the rule. Valid values: AND: All conditions must be met. OR: At least one condition must be met.	OR
items	array<object>	The list of conditions.
	object	An object that defines a single condition.
index	integer	The parameter index. `0` indicates the first parameter.	0
expr	string	The expression that is used to obtain the parameter value. Valid values: Leave empty: If left empty, the value of the parameter itself is used. .name: Obtains the value of the `name` attribute of the parameter. This is equivalent to `args0.getName()`. .isEnabled(): Obtains the value of the `enabled` attribute of the parameter. This is equivalent to `args0.isEnabled()`. [0]: The parameter must be an array. This expression obtains the first value of the array, which is equivalent to `args0[0]`. Note that the expression does not start with a period (.). .get(0): The parameter must be a list. This expression obtains the first value of the list, which is equivalent to `args0.get(0)`. .get("key"): The parameter must be a map. This expression obtains the value that corresponds to a key. This is equivalent to `args0.get("key")`.	.name
operator	string	The matching operator. Valid values: rawvalue: Performs a direct comparison. list: Matches against an allowlist of values. mod: Calculates the remainder of a division by 100. deterministic_proportional_steaming_division: Performs a percentage-based match.	rawvalue
value	string	The value to match. This value is compared with the actual value retrieved by using the specified expr and index.	test
cond	string	The comparison operator. Valid values are >, <, >=, <=, ==, and !=.	==
type	string	Not used in Dubbo services.	N/A
name	string	Not used in Dubbo services.	N/A
CreateTime	integer	The creation timestamp of the rule, in milliseconds.	1619007592013
UpdateTime	integer	The timestamp of the rule's last update, in milliseconds.	1609434061000
AppId	string	The application ID.	3faaf993-7aed-4bcd-b189-625e6a5a****
ErrorCode	string	The error code. Valid values: This parameter is not returned if the request is successful. If the request fails, the ErrorCode parameter is returned. For more information, see the Error codes section in this topic.
Code	string	The status code of the API call or a POP error code. Valid values: 2xx: The request is successful. 3xx: The request is redirected. 4xx: A client-side error occurred. 5xx: A server-side error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "9D29CBD0-45D3-410B-9826-52F86F90****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "GreyTagRouteId": 16,
    "Name": "rule-name",
    "Description": "test",
    "ScRules": [
      {
        "path": "/path",
        "condition": "OR",
        "items": [
          {
            "type": "cookie",
            "name": "test",
            "operator": "rawvalue",
            "value": "test",
            "cond": "==",
            "index": 0,
            "expr": "N/A"
          }
        ]
      }
    ],
    "AlbRules": [
      {
        "serviceId": "22",
        "ingressId": "23",
        "condition": "AND",
        "items": [
          {
            "type": "cookie",
            "name": "example",
            "operator": "rawvalue",
            "value": "test",
            "cond": "==",
            "index": 0,
            "expr": "N/A"
          }
        ]
      }
    ],
    "DubboRules": [
      {
        "serviceName": "com.alibaba.edas.boot.EchoService",
        "group": "DUBBO",
        "version": "1.0.0",
        "methodName": "echo",
        "condition": "OR",
        "items": [
          {
            "index": 0,
            "expr": ".name",
            "operator": "rawvalue",
            "value": "test",
            "cond": "==",
            "type": "N/A",
            "name": "N/A"
          }
        ]
      }
    ],
    "CreateTime": 1619007592013,
    "UpdateTime": 1609434061000,
    "AppId": "3faaf993-7aed-4bcd-b189-625e6a5a****"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.