ListVariables - 获取变量列表_实时计算 Flink版(Flink)-阿里云帮助中心

获取变量列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
stream:ListVariables	list	全部资源 *	无	无

请求语法

GET /api/v2/namespaces/{namespace}/variables

请求参数

名称	类型	必填	描述	示例值
workspace	string	是	工作空间 ID。	a14bda1c4a****
namespace	string	是	项目空间名称。	default-namespace
pageSize	integer	否	分页参数，表示所请求页码元素数量，最大值为 100，最小值为 1，默认值为 10。	10
pageIndex	integer	否	分页参数，页码索引，表示所请求页码，最小值为 1，默认值为 1。	1

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	请求 ID。	CBC799F0-ABCF-1D30-8A4F-882ED4DD****
success	boolean	表示业务请求是否成功。	true
httpCode	integer	固定值 200。	200
errorCode	string	当 success 为 false，返回业务错误码；当 success 为 true，返回空值。	""
errorMessage	string	当 success 为 false，返回业务错误信息；当 success 为 true，返回空值。	""
pageSize	integer	分页参数，表示所请求页码元素数量。	10
pageIndex	integer	分页参数，页码索引，表示所请求页码。	1
totalSize	integer	满足查询条件的所有元素的数量。	1
data	array	当 success 为 true，返回满足查询条件的变量列表；当 success 为 false，返回空值。
	Variable	变量数据。

示例

正常返回示例

JSON格式

{
  "requestId": "CBC799F0-ABCF-1D30-8A4F-882ED4DD****",
  "success": true,
  "httpCode": 200,
  "errorCode": "\"\"",
  "errorMessage": "\"\"",
  "pageSize": 10,
  "pageIndex": 1,
  "totalSize": 1,
  "data": [
    {
      "kind": "Plain",
      "name": "mysqlPassword",
      "value": "myPassword",
      "description": "test"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史