ListGreyTagRoute - - Alibaba Cloud Documentation Center

Queries the details of a canary release rule based on an application ID.

Operation description

Note You can configure only one canary release rule for each application.

Debugging

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
sae:ListGreyTagRoute	get	All Resources *	none	none

Request syntax

GET /pop/v1/sam/tagroute/greyTagRouteList

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	7171a6ca-d1cd-4928-8642-7d5cfe69****	7171a6ca-d1cd-4928-8642-7d5cfe69****

Parameters in the ScRule parameter

Parameter	Type	Example	Description
condition	String	OR	The relationship between the conditions in the canary release rule. Valid values:

AND: The conditions are in the logical AND relation. All conditions must be met at the same time.
OR: The conditions are in the logical OR relation. At least one of the conditions must be met. | | path | String | /path | The path of the canary release rule of the Spring Cloud application. | | items | Array of items | | The conditions. | Parameters in the Item parameter| Parameter | Type | Example | Description | | --------- | ---- | ------- | ----------- | | name | String | test | The name of the parameter. | | cond | String | == | The comparison operator. Valid values: >, <, >=, <=, ==, and ! =. | | type | String | cookie | The type of the comparison. Valid values:
param: parameter
cookie: cookie
header: header | | value | String | test | The value of the parameter. This value is compared with the value that is obtained based on the type and name parameters. | | operator | String | rawvalue | The operator. Valid values:
rawvalue: direct comparison.
list: whitelist.
mod: mods 100.
deterministic_proportional_steaming_division: percentage. |
Parameters in the DubboRule parameter

Parameter	Type	Example	Description
condition	String	OR	The relationship between the conditions in the canary release rule. Valid values:

AND: The conditions are in the logical AND relation. All conditions must be met at the same time.
OR: The conditions are in the logical OR relation. At least one of the conditions must be met. | | methodName | String | echo | The method name of the Dubbo service. | | serviceName | String | com.alibaba.edas.boot.EchoService | The name of the Dubbo service. | | version | String | 1.0.0 | The version of the Dubbo service. | | items | Array of items | | The conditions. | | group | String | DUBBO | The group of the Dubbo service that corresponds to the canary release rule. | Parameters in the Item parameter| Parameter | Type | Example | Description | | --------- | ---- | ------- | ----------- | | index | Integer | 0 | The index of the parameter. The value 0 indicates the first parameter. | | expr | String | .name | The expression that is used to obtain the value of the parameter. The syntax of the expression must follow the standard of the Spring Expression Language (SpEL). Valid values:
Empty: obtains the value of the parameter.
.name: obtains the name property of the parameter. This expression works the same way as args0.getName().
.isEnabled(): obtains the enabled property of the parameter. This expression works the same way as args0.isEnabled().
[0]: indicates that the value of the parameter is an array and obtains the first value of the array. This expression works the same way as args0[0]. This expression does not start with a period (.).
.get(0): indicates that the value of the parameter is a list and obtains the first value of the list. This expression works the same way as args0.get(0).
.get("key"): indicates that the value of the parameter is a map and obtains the value of the key in the map. This expression works the same way as args0.get("key"). | | cond | String | == | The comparison operator. Valid values: >, <, >=, <=, ==, and ! =. | | value | String | test | The value of the parameter. This value is compared with the value that is obtained based on the expr and index parameters. | | operator | String | rawvalue | The operator. Valid values:
rawvalue: direct comparison.
list: whitelist.
mod: mods 100.
deterministic_proportional_steaming_division: percentage. |

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	9D29CBD0-45D3-410B-9826-52F86F90****
Message	string	The returned information. Valid values: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.	success
TraceId	string	The trace ID that is used to query the details of the request.	0a98a02315955564772843261e****
Data	object	The information about the canary release rule.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned on each page. Valid value: 1.	1
TotalSize	long	The total number of canary release rules. Valid value: 1.	1
Result	array<object>	The returned result.
	object
GreyTagRouteId	long	The ID of the canary release rule.	1
Name	string	The name of the canary release rule.	rule-name
Description	string	The description of the canary release rule.	test
ScRules	array<object>	The canary release rule of the Spring Cloud application.
	object
path	string	The path of the canary release rule of the Spring Cloud application.	/path
condition	string	The relationship between the conditions in the canary release rule. Valid values: AND: The conditions are in the logical AND relation. All conditions must be met at the same time. OR: The conditions are in the logical OR relation. At least one of the conditions must be met.	OR
items	array<object>	The conditions.
	object
type	string	The type of the comparison. Valid values: param: parameter cookie: cookie header: header	cookie
name	string	The name of the parameter.	test
operator	string	The operator. Valid values: rawvalue: direct comparison. list: whitelist. mod: mods 100. deterministic_proportional_steaming_division: percentage.	rawvalue
value	string	The value of the parameter. This value is compared with the value that is obtained based on the type and name parameters.	test
cond	string	The comparison operator. Valid values: >, <, >=, <=, ==, and ! =.	==
index	integer	This parameter is not returned for Spring Cloud applications.	N/A
expr	string	This parameter is not returned for Spring Cloud applications.	N/A
DubboRules	array<object>	The canary release rule of the Dubbo service.
	object
serviceName	string	The name of the Dubbo service.	com.alibaba.edas.boot.EchoService
group	string	The group of the Dubbo service that corresponds to the canary release rule.	DUBBO
version	string	The version of the Dubbo service.	1.0.0
methodName	string	The method name of the Dubbo service.	echo
condition	string	The relationship between the conditions in the canary release rule. Valid values: AND: The conditions are in the logical AND relation. All conditions must be met at the same time. OR: The conditions are in the logical OR relation. At least one of the conditions must be met.	OR
items	array<object>	The conditions.
	object
index	integer	The index of the parameter. The value 0 indicates the first parameter.	0
expr	string	The expression that is used to obtain the value of the parameter. The syntax of the expression must follow the standard of the SpEL. Valid values: Empty: obtains the value of the parameter. .name: obtains the name property of the parameter. This expression works the same way as args0.getName(). .isEnabled(): obtains the enabled property of the parameter. This expression works the same way as args0.isEnabled(). [0]: indicates that the value of the parameter is an array and obtains the first value of the array. This expression works the same way as args0[0]. This expression does not start with a period (.). .get(0): indicates that the value of the parameter is a list and obtains the first value of the list. This expression works the same way as args0.get(0). .get("key"): indicates that the value of the parameter is a map and obtains the value of the key in the map. This expression works the same way as args0.get("key"). > For more information about the expressions that are used to obtain parameter values, see Spring Expression Language (SpEL).	.name
operator	string	The operator. Valid values: rawvalue: direct comparison. list: whitelist. mod: mods 100. deterministic_proportional_steaming_division: percentage.	rawvalue
value	string	The value of the parameter. This value is compared with the value that is obtained based on the expr and index parameters.	test
cond	string	The comparison operator. Valid values: >, <, >=, <=, ==, and ! =.	==
type	string	This parameter is not returned for Dubbo services.	N/A
name	string	This parameter is not returned for Dubbo services.	N/A
CreateTime	long	The timestamp when the canary release rule was created. Unit: milliseconds.	1619007592013
UpdateTime	long	The timestamp when the canary release rule was updated. Unit: milliseconds.	1609434061000
ErrorCode	string	The returned error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.
Code	string	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.	200
Success	boolean	Indicates whether the information of the change order was queried. Valid values: true: The information was queried. false: The information failed to be queried.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "9D29CBD0-45D3-410B-9826-52F86F90****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "PageSize": 1,
    "TotalSize": 1,
    "Result": [
      {
        "GreyTagRouteId": 1,
        "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": [
          {
            "ingressId": "23",
            "condition": "AND",
            "items": [
              {
                "type": "cookie",
                "name": "example",
                "operator": "rawvalue",
                "value": "test",
                "cond": "==",
                "index": 0,
                "expr": "N/A"
              }
            ],
            "serviceName": ""
          }
        ],
        "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
      }
    ]
  },
  "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

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

Change history

Change time	Summary of changes	Operation

No change history