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

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

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

Request syntax

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

Request parameters

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

The ID of the application.

  • 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 Example Description
RequestId String 9D29CBD0-45D3-410B-9826-52F86F90****

The ID of the request.

Message String success

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.
TraceId String 0a98a02315955564772843261e****

The trace ID that is used to query the details of the request.

Data Object

The information about the canary release rule.

CurrentPage Integer 1

The page number of the returned page.

PageSize Integer 1

The number of entries returned on each page. Valid value: 1.

TotalSize Long 1

The total number of canary release rules. Valid value: 1.

Result Array of result

The returned result.

GreyTagRouteId Long 1

The ID of the canary release rule.

Name String rule-name

The name of the canary release rule.

Description String test

The description of the canary release rule.

ScRules Array of scRule

The canary release rule of the Spring Cloud application.

path String /path

The path of the canary release rule of the Spring Cloud application.

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.
items Array of item

The conditions.

type String cookie

The type of the comparison. Valid values:

  • param: parameter
  • cookie: cookie
  • header: header
name String test

The name of the parameter.

operator String rawvalue

The operator. Valid values:

  • rawvalue: direct comparison.
  • list: whitelist.
  • mod: mods 100.
  • deterministic_proportional_steaming_division: percentage.
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.

cond String ==

The comparison operator. Valid values: >, <, >=, <=, ==, and ! =.

index Integer N/A

This parameter is not returned for Spring Cloud applications.

expr String N/A

This parameter is not returned for Spring Cloud applications.

DubboRules Array of dubboRule

The canary release rule of the Dubbo service.

serviceName String com.alibaba.edas.boot.EchoService

The name of the Dubbo service.

group String DUBBO

The group of the Dubbo service that corresponds to the canary release rule.

version String 1.0.0

The version of the Dubbo service.

methodName String echo

The method name of the Dubbo service.

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.
items Array of item

The conditions.

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 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").
    Note For more information about the expressions that are used to obtain parameter values, see Spring Expression Language (SpEL).
operator String rawvalue

The operator. Valid values:

  • rawvalue: direct comparison.
  • list: whitelist.
  • mod: mods 100.
  • deterministic_proportional_steaming_division: percentage.
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.

cond String ==

The comparison operator. Valid values: >, <, >=, <=, ==, and ! =.

type String N/A

This parameter is not returned for Dubbo services.

name String N/A

This parameter is not returned for Dubbo services.

CreateTime Long 1619007592013

The timestamp when the canary release rule was created. Unit: milliseconds.

UpdateTime Long 1609434061000

The timestamp when the canary release rule was updated. Unit: milliseconds.

ErrorCode String Empty

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 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 information of the change order was queried. Valid values:

  • true: The information was queried.
  • false: The information failed to be queried.

Examples

Sample requests

GET /pop/v1/sam/tagroute/greyTagRouteList?AppId=7171a6ca-d1cd-4928-8642-7d5cfe69**** 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

<ListGreyTagRouteResponse>
    <RequestId>9D29CBD0-45D3-410B-9826-52F86F90****</RequestId>
    <Message>success</Message>
    <TraceId>0a98a02315955564772843261e****</TraceId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <PageSize>1</PageSize>
        <TotalSize>1</TotalSize>
        <Result>
            <GreyTagRouteId>1</GreyTagRouteId>
            <Name>rule-name</Name>
            <Description>test</Description>
            <ScRules>
                <path>/path</path>
                <condition>OR</condition>
                <items>
                    <type>cookie</type>
                    <name>test</name>
                    <operator>rawvalue</operator>
                    <value>test</value>
                    <cond>==</cond>
                    <expr>N/A</expr>
                </items>
            </ScRules>
            <DubboRules>
                <serviceName>com.alibaba.edas.boot.EchoService</serviceName>
                <group>DUBBO</group>
                <version>1.0.0</version>
                <methodName>echo</methodName>
                <condition>OR</condition>
                <items>
                    <index>0</index>
                    <expr>.name</expr>
                    <operator>rawvalue</operator>
                    <value>test</value>
                    <cond>==</cond>
                    <type>N/A</type>
                    <name>N/A</name>
                </items>
            </DubboRules>
            <CreateTime>1619007592013</CreateTime>
            <UpdateTime>1609434061000</UpdateTime>
        </Result>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</ListGreyTagRouteResponse>

JSON format

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

{
  "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" : "==",
          "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
    } ]
  },
  "Code" : "200",
  "Success" : true
}

Error codes

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

For a list of error codes, visit the API Error Center.