DescribeAllRootVariable

Updated at:

Displays all root variables when testing a custom expression.

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

yundun-saf:Describe

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SourceIp

string

No

The source IP address of the request. You do not need to specify this parameter. The system automatically retrieves it.

61.169.104.202

Lang

string

No

Specifies the language for requests and response messages. Default value: zh. Valid values:

  • zh: Chinese.

  • en: English.

zh

id

integer

No

The variable ID.

2557

regId

string

No

The region code.

cn-hangzhou

eventCode

string

No

The event code.

de_arqbuy7206

nativeVariableIds

string

No

The list of event fields.

[106780]

deviceVariableIds

string

No

The list of device variables.

[180]

expressionVariableIds

string

No

The list of custom variables.

[6780]

velocityVariableIds

string

No

The custom cumulative variables.

[780]

queryVariableIds

string

No

The custom query variables.

[2678]

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The request ID.

A32FE941-35F2-5378-B37C-4B8FDB16F094

resultObject

array<object>

The returned object.

array<object>

The returned object.

id

integer

The variable ID.

497

title

string

The title.

Age

name

string

The variable name.

age

description

string

The variable description.

Age

type

string

The variable type.

NATIVE

inputs

string

The inputs of the variable.

age

fieldType

string

The field type.

STRING

code

string

The variable code.

age

displayType

string

The display type and group label.

NATIVE

favoriteFlag

boolean

The favorite flag.

true

fieldRank

integer

The field ranking.

1

inputFieldType

string

The input type of the parameter.

STRING

outputThreshold

object

The maximum cross-sectional area of the check box.

minValue

number

The minimum value.

10

maxValue

number

The maximum value.

1000

sourceType

string

The data source.

SAF

Examples

Success response

JSON format

{
  "RequestId": "A32FE941-35F2-5378-B37C-4B8FDB16F094",
  "resultObject": [
    {
      "id": 497,
      "title": "年龄",
      "name": "age",
      "description": "年龄",
      "type": "NATIVE",
      "inputs": "age",
      "fieldType": "STRING",
      "code": "age",
      "displayType": "NATIVE",
      "favoriteFlag": true,
      "fieldRank": 1,
      "inputFieldType": "STRING",
      "outputThreshold": {
        "minValue": 10,
        "maxValue": 1000
      },
      "sourceType": "SAF"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.