AI 助理
文档备案控制台
官方文档
首页 实时计算 Flink版 流计算Flink 开发参考 OpenAPI 售卖控制台API参考 API目录 工作空间 DescribeInstances - 查看已购买Flink全托管工作空间

DescribeInstances - 查看已购买Flink全托管工作空间

更新时间：
复制 MD 格式
产品详情
我的收藏

查询一个或多个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
Elastic

boolean

否

是否是混合计费

true
Tags

array<object>

否

实例的标签集合。

object

否

实例标签

Value

string

否

标签的值。 长度限制为 64 Unicode 字符。

ys
Key

string

否

标签键。

test
ResourceGroupId

string

否

ArchitectureType

string

否

架构类型

X86
InstanceName

string

否

实例名称

e2e-test
NamespaceName

string

否

namespace 名称

e2e-test-default

返回参数

名称

类型

描述

示例值

object

TotalCount

integer

总实例数目

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>

实例组详情

array<object>

实例详情

ResourceGroupId

string

MonitorType

string

HaResourceSpec

object

Cpu

integer

MemoryGB

integer

ResourceCreateTime

integer

实例创建时间。

1629879567394
Elastic

boolean

HaZoneId

string

VSwitchInfo

array<object>

object

Description

string

VpcId

string

ZoneId

string

VSwitchCidr

string

VSwitchId

string

AvailableIpAddressCount

string

VSwitchName

string

RegionId

string

Ha

boolean

VpcInfo

object

Status

string

Description

string

VpcId

string

CidrBlock

string

VpcName

string

RegionId

string

Tags

array<object>

标签列表。

object

标签

Value

string

标签值

test
Key

string

标签键

flink
ArchitectureType

string

ClusterState

object

Status

string

CreateTimeout

boolean

ClusterStage

object

Status

string

Message

string

ClusterId

string

CurrentStage

integer

TotalStageWithWeight

array<object>

object

StepIndex

integer

StepName

string

Weight

integer

VpcCidr

string

ClusterId

string

SubStatus

string

Url

string

UserSlbDto

object

SlbId

string

SlbIp

string

ExistSlb

boolean

UserSlbListeners

array<object>

object

ListenersStatus

string

Port

string

SlbStatus

string

ZoneId

string

实例所属的可用区 ID。

cn-beijing-g
VSwitchIds

array

虚拟交换机 ID 组。

string

虚拟交换机 ID。

vsw-2ze6yqnc19*****psjj0j
InstanceId

string

实例 ID。

f-cn-zvp2q0z****
ResourceExpiredTime

integer

超期时间

1637337600000
AskClusterId

string

ResourceSpec

object

资源规格信息

Cpu

integer

CPU 数量。

10
MemoryGB

integer

设置的内存数量。

40
HaVSwitchInfo

array<object>

object

Description

string

VpcId

string

ZoneId

string

VSwitchCidr

string

VSwitchId

string

AvailableIpAddressCount

integer

VSwitchName

string

RegionId

string

HaVSwitchIds

array

string

ClusterUsedStorage

object

ClusterId

string

UsedStorage

number

InstanceName

string

工作空间名称。

vvp1
HostAliases

array<object>

object

Ip

string

HostNames

array

string

Uid

string

实例所属用户 ID。

183899668736****
ClusterUsedResources

object

ElasticUsedMemory

number

ClusterId

string

ElasticUsedCpu

number

UsedCpu

number

GuaranteedUsedResource

number

GuaranteedUsedCpu

number

HaUsedCpu

number

UsedMemory

number

UsedResource

number

Ha

boolean

HaUsedMemory

number

HaUsedResource

number

ElasticUsedResource

number

GuaranteedUsedMemory

number

ElasticResourceSpec

object

Cpu

integer

MemoryGB

integer

Storage

object

存储信息。

FullyManaged

boolean

SupportMigrationProgressDetection

boolean

OrderState

string

SupportCreateFullyManagedStorage

boolean

Oss

object

OSS 存储信息。

Bucket

string

OSS 的 Bucket 名称。

oss_flink
VpcId

string

专有网络 id

vpc-2ze9*******nxfmfcdi
ResourceId

string

资源 ID。

b3690a1655****
ChargeType

string

付费类型，取值如下：

  • POST：按量付费

  • PRE：包年包月

PRE
Ansm

boolean

Region

string

实例所属地区

cn-beijing
ElasticOrderState

string

ElasticInstanceId

string

弹性订单 id

f-cn-e3afbd321
OssInfo

object

Endpoint

string

AccessId

string

Bucket

string

BucketVersioningStatus

string

AccessKey

string

OrderState

string

订单状态，取值如下：

  • NOT_INIT：下单还未部署组件。

  • NORMAL：正常状态。

  • CEASE：过期状态。

  • RELEASE：超期状态。

NORMAL
ClusterStatus

string

集群状态，取值如下：

  • CREATING：创建中。

  • RUNNING：运行中。

  • DISABLE：无效。

  • DELETING：删除中。

  • DELETED：已删除。

RUNNING
SupportDisasterRecoveryDrill

boolean

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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

上一篇：RenewInstance - 续费flink全托管工作空间下一篇：DeleteInstance - 释放按量付费Flink全托管工作空间