DescribeInstances - 查看已购买Flink全托管工作空间_实时计算 Flink版(Flink)-阿里云帮助中心

查询一个或多个flink全托管工作空间的详细信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
stream:DescribeVvpInstances	list	VvpInstance acs:stream:{#regionId}:{#accountId}:vvpinstance/{#InstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
PageIndex	integer	否	当前页数。	2
PageSize	integer	否	分页查询时设置的每页行数，最大值为 100 行。默认值：10。	10
InstanceId	string	否	订单实例 ID。	f-cn-wwo36qj4g06
Region	string	是	地域 ID。	cn-shenzhen
ChargeType	string	否	付款类型枚举值： PRE POST	PRE
Tags	array<object>	否	实例的标签集合。
	object	否	实例标签
Key	string	否	标签键。	test
Value	string	否	标签的值。长度限制为 64 Unicode 字符。	ys

返回参数

名称	类型	描述	示例值
	object
TotalCount	long	总实例数目	15
TotalPage	integer	总页数	2
PageIndex	integer	当前页码	1
PageSize	integer	分页属性，每页多少实例	10
RequestId	string	请求 ID。	C8DF2A5B-6FBA-5651-A3D4-960F3664****
Success	boolean	是否成功，取值如下： true：成功。 false：失败。	true
Instances	array<object>	实例组详情
instance信息	object	实例详情
ResourceCreateTime	long	实例创建时间。	1629879567394
ResourceExpiredTime	long	超期时间	1637337600000
Region	string	实例所属地区	cn-beijing
ZoneId	string	实例所属的可用区 ID。	cn-beijing-g
VpcId	string	专有网络 id	vpc-2ze9*******nxfmfcdi
VSwitchIds	array	虚拟交换机 ID 组。
虚拟交换机id	string	虚拟交换机 ID。	vsw-2ze6yqnc19*****psjj0j
InstanceId	string	实例 ID。	f-cn-zvp2q0z****
ChargeType	string	付费类型，取值如下： POST：按量付费 PRE：包年包月	PRE
InstanceName	string	工作空间名称。	vvp1
Uid	string	实例所属用户 ID。	183899668736****
OrderState	string	订单状态，取值如下： NOT_INIT：下单还未部署组件。 NORMAL：正常状态。 CEASE：过期状态。 RELEASE：超期状态。	NORMAL
ResourceId	string	资源 ID。	b3690a1655****
Storage	object	存储信息。
Oss	object	OSS 存储信息。
Bucket	string	OSS 的 Bucket 名称。	oss_flink
ResourceSpec	object	资源规格信息
Cpu	integer	CPU 数量。	10
MemoryGB	integer	设置的内存数量。	40
ClusterStatus	string	集群状态，取值如下： CREATING：创建中。 RUNNING：运行中。 DISABLE：无效。 DELETING：删除中。 DELETED：已删除。	RUNNING
Tags	array<object>	标签列表。
tag信息	object	标签
Key	string	标签键	flink
Value	string	标签值	test

示例

正常返回示例

JSON格式

{
  "TotalCount": 15,
  "TotalPage": 2,
  "PageIndex": 1,
  "PageSize": 10,
  "RequestId": "C8DF2A5B-6FBA-5651-A3D4-960F3664****",
  "Success": true,
  "Instances": [
    {
      "ResourceCreateTime": 1629879567394,
      "ResourceExpiredTime": 1637337600000,
      "Region": "cn-beijing",
      "ZoneId": "cn-beijing-g",
      "VpcId": "vpc-2ze9*******nxfmfcdi",
      "VSwitchIds": [
        "vsw-2ze6yqnc19*****psjj0j"
      ],
      "InstanceId": "f-cn-zvp2q0z****",
      "ChargeType": "PRE",
      "InstanceName": "vvp1",
      "Uid": "183899668736****",
      "OrderState": "NORMAL",
      "ResourceId": "b3690a1655****",
      "Storage": {
        "Oss": {
          "Bucket": "oss_flink"
        },
        "FullyManaged": true,
        "OrderState": ""
      },
      "ResourceSpec": {
        "Cpu": 10,
        "MemoryGB": 40
      },
      "ClusterStatus": "RUNNING",
      "Tags": [
        {
          "Key": "flink",
          "Value": "test"
        }
      ],
      "AskClusterId": "",
      "ResourceGroupId": "",
      "HostAliases": [
        {
          "Ip": "",
          "HostNames": [
            ""
          ]
        }
      ],
      "ArchitectureType": "",
      "Ha": true,
      "HaZoneId": "",
      "HaVSwitchIds": [
        ""
      ],
      "HaResourceSpec": {
        "Cpu": 0,
        "MemoryGB": 0
      },
      "MonitorType": "",
      "VpcInfo": {
        "VpcName": "",
        "VpcId": "",
        "Status": "",
        "CidrBlock": "",
        "Description": "",
        "RegionId": ""
      },
      "VSwitchInfo": [
        {
          "VpcId": "",
          "VSwitchId": "",
          "Description": "",
          "AvailableIpAddressCount": "",
          "ZoneId": "",
          "VSwitchCidr": "",
          "VSwitchName": "",
          "RegionId": ""
        }
      ],
      "ClusterUsedResources": [
        {
          "UsedMemory": 0,
          "UsedResource": 0,
          "UsedCpu": 0,
          "ClusterId": "",
          "Ha": true,
          "HaUsedMemory": 0,
          "HaUsedResource": 0,
          "HaUsedCpu": 0
        }
      ],
      "HaVSwitchInfo": [
        {
          "VpcId": "",
          "VSwitchId": "",
          "Description": "",
          "AvailableIpAddressCount": 0,
          "ZoneId": "",
          "VSwitchCidr": "",
          "VSwitchName": "",
          "RegionId": ""
        }
      ],
      "ClusterState": {
        "Status": "",
        "SubStatus": "",
        "Url": "",
        "CreateTimeout": true,
        "UserSlbDto": {
          "ExistSlb": true,
          "SlbIp": "",
          "SlbId": "",
          "SlbStatus": "",
          "UserSlbListeners": [
            {
              "Port": "",
              "ListenersStatus": ""
            }
          ]
        },
        "VpcCidr": "",
        "ClusterId": "",
        "ClusterStage": {
          "Status": "",
          "Message": "",
          "CurrentStage": 0,
          "ClusterId": "",
          "TotalStageWithWeight": [
            {
              "Weight": 0,
              "StepIndex": 0,
              "StepName": ""
            }
          ]
        }
      },
      "ClusterUsedStorage": {
        "ClusterId": "",
        "UsedStorage": 0
      },
      "OssInfo": {
        "AccessKey": "",
        "AccessId": "",
        "Bucket": "",
        "Endpoint": "",
        "BucketVersioningStatus": ""
      }
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-08-05	OpenAPI 返回结构发生变更	查看变更详情
2024-07-31	OpenAPI 返回结构发生变更	查看变更详情
2024-03-07	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情