DescribeInstances查询Flink全托管工作空间详细信息-实时计算 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
Elastic	boolean	否	是否是混合计费	true
Tags	array<object>	否	实例的标签集合。
	object	否	实例标签
Key	string	否	标签键。	test
Value	string	否	标签的值。长度限制为 64 Unicode 字符。	ys
ResourceGroupId	string	否	实例所属的资源组 ID。	rg-aek2e55emewbqgy
ArchitectureType	string	否	处理器架构，可使用 X86 或者 ARM。枚举值： X86 : X86 ARM : ARM	X86
InstanceName	string	否	实例名称	e2e-test
NamespaceName	string	否	namespace 名称	e2e-test-default

返回参数

名称	类型	描述	示例值
	object	查询工作空间详情的响应信息。
Instances	array<object>	实例组详情
	array<object>	实例详情
Ansm	boolean		true
ArchitectureType	string	处理器架构。枚举值： X86 : X86 ARM : ARM	X86
AskClusterId	string	集群 id。	c20c******404
ChargeType	string	付费类型，取值如下： POST：按量付费 PRE：包年包月	PRE
ClusterState	object	集群状态。
ClusterId	string	集群 ID。	a6f35c0ff73448
ClusterStage	object	集群阶段信息。
ClusterId	string	集群 ID。	f0957e82de6e47
CurrentStage	integer	当前阶段序号。	0
Message	string	错误信息
Status	string	项目空间的状态，取值如下： CREATING：正在创建。 DELETING：正在删除。 MODIFYING：正在修改资源规格。 SUCCESS：上一个操作执行成功。 FAILED：上一个操作执行失败。	CREATING
TotalStageWithWeight	array<object>	阶段及权重列表。
	object	单个阶段及其权重。
StepIndex	integer	阶段序号。	0
StepName	string	阶段名称。
Weight	integer	阶段权重。	0
CreateTimeout	boolean	集群创建是否超时。	true
Status	string	集群状态，取值如下： CREATING：创建中。 RUNNING：运行中。 DISABLE：无效。 DELETING：删除中。 DELETED：已删除。枚举值： CREATING : 创建中	RUNNING
SubStatus	string	集群状态，取值如下： CREATING：创建中。 RUNNING：运行中。 DISABLE：无效。 DELETING：删除中。 DELETED：已删除。	RUNNING
Url	string	集群相关地址。
UserSlbDto	object	用户侧负载均衡信息。
ExistSlb	boolean	是否存在用户侧负载均衡实例。
SlbId	string	负载均衡实例 ID。
SlbIp	string	负载均衡实例 IP 地址。
SlbStatus	string	负载均衡实例状态。
UserSlbListeners	array<object>	用户侧负载均衡监听列表。
	object	单个负载均衡监听信息。
ListenersStatus	string	监听状态。
Port	string	监听端口。
VpcCidr	string	集群所在 VPC 的网段。
ClusterStatus	string	集群状态，取值如下： CREATING：创建中。 RUNNING：运行中。 DISABLE：无效。 DELETING：删除中。 DELETED：已删除。枚举值： DISABLE : 无效 RUNNING : 运行中 DELETING : 删除中 DELETED : 已删除 CREATING : 创建中	RUNNING
ClusterUsedResources	object	flink 服务整体资源情况。
ClusterId	string	集群 ID。	ea2e9545fdc942
ElasticUsedCpu	number	已使用的弹性 CPU 数量。	0
ElasticUsedMemory	number	已使用的弹性内存量。	0
ElasticUsedResource	number	已使用的弹性资源数量。	0
GuaranteedUsedCpu	number	已使用的保障资源 CPU 数量。	0
GuaranteedUsedMemory	number	已使用的保障资源内存量。	0
GuaranteedUsedResource	number	已使用的保障资源数量。	0
Ha	boolean	是否选择同城高可用资源。	true
HaUsedCpu	number	已使用的同城高可用 CPU 数量。	0
HaUsedMemory	number	已使用的同城高可用内存量。	0
HaUsedResource	number	已使用的同城高可用计算单元数量。	0
UsedCpu	number	已使用的 CPU 总量。	0
UsedMemory	number	已使用的内存总量。	0
UsedResource	number	已使用的计算单元总量。	0
ClusterUsedStorage	object	集群已使用的存储资源信息。
ClusterId	string	集群 ID。	f0957e82de6e47
UsedStorage	number	集群已使用的存储量。	0
DeletionProtection	boolean	是否已开启关闭保护	false
Elastic	boolean	是否启用弹性资源。	false
ElasticInstanceId	string	弹性订单 id	f-cn-e3afbd321
ElasticOrderState	string	弹性资源订单状态。
ElasticResourceSpec	object	按量付费弹性资源规格。
Cpu	integer	CPU 数量。	5
MemoryGB	integer	已使用的内存数量。	280
Ha	boolean	是否选择同城高可用资源。	true
HaResourceSpec	object	同城高可用资源描述。
Cpu	integer	同城高可用 CPU 数量。	12
MemoryGB	integer	同城高可用资源的内存大小。	48
HaVSwitchIds	array	同城高可用备可用区 vswitch 组。
	string	同城高可用备可用区 vswitch。	vsw-j6cft0ogy3agw*****
HaVSwitchInfo	array<object>	同城高可用备交换机组信息。
	object	备可用区交换机详情。
AvailableIpAddressCount	integer	交换机中可用的 IP 地址数量。	64
Description	string	vpc 信息描述。	“”
RegionId	string	地域。	cn-beijing
VSwitchCidr	string	交换机网段信息。	192.168.16.0/24
VSwitchId	string	交换机 ID。	vsw-wz9e9zt38b9f3l6*****
VSwitchName	string	交换机名称。	测试交换机
VpcId	string	专有网络 VPC ID。	vpc-uf6d0akr6lzd75v****
ZoneId	string	工作空间所属的可用区 ID。	cn-hangzhou-h
HaZoneId	string	同城高可用备可用区 ID。	cn-hongkong-b
HostAliases	array<object>	用户添加的域名信息。
	object	单条主机名与 IP 地址映射。
HostNames	array	主机名列表。
	string	主机名。
Ip	string	主机名对应的 IP 地址。
InstanceId	string	实例 ID。	f-cn-zvp2q0z****
InstanceName	string	工作空间名称。	vvp1
MonitorType	string	监控报警服务类型，可以选择 arms 或云监控。枚举值： TAIHAO : TAIHAO ARMS : ARMS	TAIHAO
OrderState	string	flink 计算服务订单状态，取值如下： NOT_INIT：下单还未部署组件。 NORMAL：正常状态。 CEASE：过期状态。 RELEASE：超期状态。枚举值： NOT_INIT : 下单还未部署组件 CEASE : 过期 RELEASE : 超期 NORMAL : 正常	NORMAL
OssInfo	object	OSS 存储访问配置信息。
AccessId	string	OSS 访问身份标识。
AccessKey	string	OSS 访问密钥。
Bucket	string	绑定 OSS 的 Bucket 名称。	flink-log-john
BucketVersioningStatus	string	OSS Bucket 的版本控制状态。
Endpoint	string	OSS 访问端点。
Region	string	实例所属地区	cn-beijing
ResourceCreateTime	integer	实例创建时间，Unix 时间戳，单位为毫秒。	1629879567394
ResourceExpiredTime	integer	实例到期时间，Unix 时间戳，单位为毫秒。	1637337600000
ResourceGroupId	string	资源组。	rg-***
ResourceId	string	资源 ID。	b3690a1655****
ResourceSpec	object	资源规格信息
Cpu	integer	CPU 数量。	10
MemoryGB	integer	设置的内存数量。	40
Storage	object	存储信息。
FullyManaged	boolean	是否选择全托管存储。 true：使用。 false：不使用。	true
OrderState	string	全托管存储订单状态。取值如下： NOT_INIT：下单还未部署组件。 NORMAL：正常状态。 CEASE：过期状态。 RELEASE：超期状态。枚举值： NOT_INIT : 下单还未部署组件 CEASE : 过期 RELEASE : 超期 NORMAL : 正常	NORMAL
Oss	object	OSS 存储信息。
Bucket	string	绑定 OSS 的 Bucket 名称。	oss_flink
SupportCreateFullyManagedStorage	boolean	是否支持创建全托管存储。	true
SupportMigrationProgressDetection	boolean	是否支持检测迁移进度。	true
SupportDisasterRecoveryDrill	boolean	是否支持容灾演练。
Tags	array<object>	标签列表。
	object	标签
Key	string	标签键	flink
Value	string	标签值	test
Uid	string	实例所属用户 ID。	183899668736****
VSwitchIds	array	虚拟交换机 ID 组。
	string	虚拟交换机 ID。	vsw-2ze6yqnc19*****psjj0j
VSwitchInfo	array<object>	主交换机组信息。
	object	交换机信息。
AvailableIpAddressCount	string	交换机中可用的 IP 地址数量。	256
Description	string	交换组描述。	“”
RegionId	string	地域 ID。	cn-shanghai
VSwitchCidr	string	交换机网段。	192.168.16.0/24
VSwitchId	string	交换机 ID。	vsw-8vb6jk75wfcwnuq****
VSwitchName	string	交换机的名称。	“”
VpcId	string	VPC ID。	vpc-bp16h9ru9gvz2tygo*****
ZoneId	string	工作空间所属的可用区 ID。	cn-hangzhou-h
VpcId	string	专有网络 id	vpc-2ze9*******nxfmfcdi
VpcInfo	object	VPC 信息。
CidrBlock	string	VPC 网段信息。	172.16.5.0/24
Description	string	VPC 描述。	“”
RegionId	string	地域 ID。	cn-hangzhou
Status	string	VPC 状态。 Pending：配置中。 Available：可用。枚举值： Available : 可用 Pending : 配置中	Available
VpcId	string	专有网络 VPC ID。	vpc-gw8c6nhjta3eq12y****
VpcName	string	VPC 名称。	flink集群vpc
ZoneId	string	实例所属的可用区 ID。	cn-beijing-g
PageIndex	integer	当前页码	1
PageSize	integer	分页属性，每页多少实例	10
RequestId	string	请求 ID。	C8DF2A5B-6FBA-5651-A3D4-960F3664****
Success	boolean	是否成功，取值如下： true：成功。 false：失败。	true
TotalCount	integer	总实例数目	15
TotalPage	integer	总页数	2

示例

正常返回示例

JSON格式

{
  "Instances": [
    {
      "Ansm": true,
      "ArchitectureType": "X86",
      "AskClusterId": "c20c******404",
      "ChargeType": "PRE",
      "ClusterState": {
        "ClusterId": "a6f35c0ff73448",
        "ClusterStage": {
          "ClusterId": "f0957e82de6e47",
          "CurrentStage": 0,
          "Message": "",
          "Status": "CREATING",
          "TotalStageWithWeight": [
            {
              "StepIndex": 0,
              "StepName": "",
              "Weight": 0
            }
          ]
        },
        "CreateTimeout": true,
        "Status": "RUNNING",
        "SubStatus": "RUNNING",
        "Url": "",
        "UserSlbDto": {
          "ExistSlb": true,
          "SlbId": "",
          "SlbIp": "",
          "SlbStatus": "",
          "UserSlbListeners": [
            {
              "ListenersStatus": "",
              "Port": ""
            }
          ]
        },
        "VpcCidr": ""
      },
      "ClusterStatus": "RUNNING",
      "ClusterUsedResources": {
        "ClusterId": "ea2e9545fdc942",
        "ElasticUsedCpu": 0,
        "ElasticUsedMemory": 0,
        "ElasticUsedResource": 0,
        "GuaranteedUsedCpu": 0,
        "GuaranteedUsedMemory": 0,
        "GuaranteedUsedResource": 0,
        "Ha": true,
        "HaUsedCpu": 0,
        "HaUsedMemory": 0,
        "HaUsedResource": 0,
        "UsedCpu": 0,
        "UsedMemory": 0,
        "UsedResource": 0
      },
      "ClusterUsedStorage": {
        "ClusterId": "f0957e82de6e47",
        "UsedStorage": 0
      },
      "DeletionProtection": false,
      "Elastic": false,
      "ElasticInstanceId": "f-cn-e3afbd321",
      "ElasticOrderState": "",
      "ElasticResourceSpec": {
        "Cpu": 5,
        "MemoryGB": 280
      },
      "Ha": true,
      "HaResourceSpec": {
        "Cpu": 12,
        "MemoryGB": 48
      },
      "HaVSwitchIds": [
        "vsw-j6cft0ogy3agw*****"
      ],
      "HaVSwitchInfo": [
        {
          "AvailableIpAddressCount": 64,
          "Description": "“”",
          "RegionId": "cn-beijing",
          "VSwitchCidr": "192.168.16.0/24",
          "VSwitchId": "vsw-wz9e9zt38b9f3l6*****",
          "VSwitchName": "测试交换机",
          "VpcId": "vpc-uf6d0akr6lzd75v****",
          "ZoneId": "cn-hangzhou-h"
        }
      ],
      "HaZoneId": "cn-hongkong-b",
      "HostAliases": [
        {
          "HostNames": [
            ""
          ],
          "Ip": ""
        }
      ],
      "InstanceId": "f-cn-zvp2q0z****",
      "InstanceName": "vvp1",
      "MonitorType": "TAIHAO",
      "OrderState": "NORMAL",
      "OssInfo": {
        "AccessId": "",
        "AccessKey": "",
        "Bucket": "flink-log-john",
        "BucketVersioningStatus": "",
        "Endpoint": ""
      },
      "Region": "cn-beijing",
      "ResourceCreateTime": 1629879567394,
      "ResourceExpiredTime": 1637337600000,
      "ResourceGroupId": "rg-***",
      "ResourceId": "b3690a1655****",
      "ResourceSpec": {
        "Cpu": 10,
        "MemoryGB": 40
      },
      "Storage": {
        "FullyManaged": true,
        "OrderState": "NORMAL",
        "Oss": {
          "Bucket": "oss_flink"
        },
        "SupportCreateFullyManagedStorage": true,
        "SupportMigrationProgressDetection": true
      },
      "SupportDisasterRecoveryDrill": true,
      "Tags": [
        {
          "Key": "flink",
          "Value": "test"
        }
      ],
      "Uid": "183899668736****",
      "VSwitchIds": [
        "vsw-2ze6yqnc19*****psjj0j"
      ],
      "VSwitchInfo": [
        {
          "AvailableIpAddressCount": "256",
          "Description": "“”",
          "RegionId": "cn-shanghai",
          "VSwitchCidr": "192.168.16.0/24",
          "VSwitchId": "vsw-8vb6jk75wfcwnuq****",
          "VSwitchName": "“”",
          "VpcId": "vpc-bp16h9ru9gvz2tygo*****",
          "ZoneId": "cn-hangzhou-h"
        }
      ],
      "VpcId": "vpc-2ze9*******nxfmfcdi",
      "VpcInfo": {
        "CidrBlock": "172.16.5.0/24",
        "Description": "“”",
        "RegionId": "cn-hangzhou",
        "Status": "Available",
        "VpcId": "vpc-gw8c6nhjta3eq12y****",
        "VpcName": "flink集群vpc"
      },
      "ZoneId": "cn-beijing-g"
    }
  ],
  "PageIndex": 1,
  "PageSize": 10,
  "RequestId": "C8DF2A5B-6FBA-5651-A3D4-960F3664****",
  "Success": true,
  "TotalCount": 15,
  "TotalPage": 2
}

错误码

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

变更历史

更多信息，参考变更详情。