CreateCustVariable

Updated at:

Creates a cumulative variable.

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

Lang

string

No

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

  • zh: Chinese.

  • en: English.

zh

regId

string

No

The region code.

cn-hangzhou

eventCodes

string

Yes

The event code.

de_ahqhsw7665,de_agbzfi5134

velocityFC

string

Yes

The variable type.

Valid values:

  • AVG :

    Average value.

  • MIN :

    Minimum value.

  • MAX :

    Maximum value.

  • DISTINCT :

    Deduplication function by object.

  • COUNT :

    Cumulative count of the subject on the object.

  • SUM :

    Total operations of the subject on the object.

  • HISTORY :

    Historical value.

DISTINCT

historyValueType

string

No

The value type.

Valid values:

  • LAST :

    Latest.

  • EARLIEST :

    Earliest.

EARLIEST

outputs

string

No

The variable return type.

STRING

title

string

Yes

The title.

Cumulative IP call count

description

string

No

The description.

Description of cumulative IP call count

timeType

string

Yes

The time slice type. It is used to identify the statistical period of the cumulative variable and does not represent a specific date or time.

CURRENT

twCount

integer

No

The time count.

1

velocityTW

string

Yes

The time slice unit.

Valid values:

  • DAY_1 :

    1 day.

  • MONTH_1 :

    1 month.

  • WEEK_1 :

    1 week.

  • MINITE_30 :

    30 minutes.

  • HOUR_1 :

    1 hour.

  • HOUR_12 :

    12 hours.

  • MINITE_5 :

    5 minutes.

  • MINITE_1 :

    1 minute.

DAY_1

subject

string

Yes

The subject.

name

object

string

No

The object.

age

createType

string

No

The creation type.

NORMAL

condition

string

No

The condition value.

{"relationship":"and","list":[{"deepCount":1,"left":{"hasRightVariable":true,"fieldType":"INT","functionName":"","leftVariableType":"NATIVE","name":"DEtest222","operatorCode":"equals"},"right":{"rightVariableType":"constant","name":"11","functionName":""},"operatorCode":"equals"}]}

Response elements

Element

Type

Description

Example

object

resultObject

boolean

The returned object.

true

RequestId

string

The request ID.

A32FE941-35F2-5378-B37C-4B8FDB16F094

Examples

Success response

JSON format

{
  "resultObject": true,
  "RequestId": "A32FE941-35F2-5378-B37C-4B8FDB16F094"
}

Error codes

HTTP status code

Error code

Error message

Description

200 1202 Data duplication. Data:(%s:%s) duplicate

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.