您可以调用DescribeInstances查询一台或多台实例的详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstances

系统规定参数。取值为DescribeInstances。

DescribeInstancesRequest Object

查询实例详细信息的请求参数。

PageIndex Integer 1

实例状态列表的页码。

起始值为1。

PageSize Integer 2

分页查询时设置的每页行数。

最大值为100。

InstanceId String 223493C7-FCA9-13D4-B75B-AF8B32F4****

实例ID。

Region String cn-beijing

实例所属的地域ID。

ChargeType String PRE

付费类型,取值如下:

  • POST:按量付费
  • PRE:包年包月

返回数据

名称 类型 示例值 描述
TotalCount Long 15

查询到的实例总数。

TotalPage Integer 2

查询到的实例总页数。

PageIndex Integer 1

当前页数。

PageSize Integer 10

设置的每页行数。

RequestId String 67F33190-946B-1105-B6A1-E2DF0426DD51

请求ID。

Success Boolean true

是否成功,取值如下:

  • true:成功。
  • false:失败。
Instances Array of instance信息

返回实例的信息。

ResourceCreateTime Long 1629879567394

实例创建时间。

Region String cn-beijing

实例所属的地域ID。

ZoneId String cn-beijing-g

实例所属的可用区ID。

VpcId String vpc-2ze9*******nxfmfcdi

用户的VPC ID。

VSwitchIds Array of String vsw-2ze6yqnc19*****psjj0j

虚拟交换机ID。

InstanceId String sc_flinkserverlesspost_public_cn-0ju2bj2****

实例ID。

ChargeType String PRE

付费类型,取值如下:

  • POST:按量付费
  • PRE:包年包月
InstanceName String vvp1

实例名称。

Uid String 1838996687368452

实例所属用户ID。

OrderState String NORMAL

订单状态,取值如下:

  • NOT_INIT:下单还未部署组件。
  • NORMAL:正常状态。
  • CEASE:过期状态。
  • RELEASE:超期状态。
ResourceId String b3690a1655da47

K8s集群ID。

Storage Object

存储信息。

Oss Object

OSS存储信息。

Bucket String oss_flink

OSS的Bucket名称。

ResourceSpec Object

资源规格。

Cpu Integer 10

设置的CPU数量。

MemoryGB Integer 40

设置的内存数量。

ClusterStatus String RUNNING

集群状态,取值如下:

  • CREATING:创建中。
  • RUNNING:运行中。
  • DISABLE:无效。
  • DELETING:删除中。
  • DELETED:已删除。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstances
&DescribeInstancesRequest={"PageIndex":1,"PageSize":2,"InstanceId":"223493C7-FCA9-13D4-B75B-AF8B32F4****","Region":"cn-beijing","ChargeType":"PRE"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstancesResponse>
    <TotalCount>15</TotalCount>
    <TotalPage>2</TotalPage>
    <PageIndex>1</PageIndex>
    <PageSize>10</PageSize>
    <RequestId>67F33190-946B-1105-B6A1-E2DF0426DD51</RequestId>
    <Success>true</Success>
    <Instances>
        <ResourceCreateTime>1629879567394</ResourceCreateTime>
        <Region>cn-beijing</Region>
        <ZoneId>cn-beijing-g</ZoneId>
        <VpcId>vpc-2ze9*******nxfmfcdi</VpcId>
        <VSwitchIds>vsw-2ze6yqnc19*****psjj0j</VSwitchIds>
        <InstanceId>sc_flinkserverlesspost_public_cn-0ju2bj2****</InstanceId>
        <ChargeType>PRE</ChargeType>
        <InstanceName>vvp1</InstanceName>
        <Uid>1838996687368452</Uid>
        <OrderState>NORMAL</OrderState>
        <ResourceId>b3690a1655da47</ResourceId>
        <Storage>
            <Oss>
                <Bucket>oss_flink</Bucket>
            </Oss>
        </Storage>
        <ResourceSpec>
            <Cpu>10</Cpu>
            <MemoryGB>40</MemoryGB>
        </ResourceSpec>
        <ClusterStatus>RUNNING</ClusterStatus>
    </Instances>
</DescribeInstancesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 15,
  "TotalPage" : 2,
  "PageIndex" : 1,
  "PageSize" : 10,
  "RequestId" : "67F33190-946B-1105-B6A1-E2DF0426DD51",
  "Success" : true,
  "Instances" : [ {
    "ResourceCreateTime" : 1629879567394,
    "Region" : "cn-beijing",
    "ZoneId" : "cn-beijing-g",
    "VpcId" : "vpc-2ze9*******nxfmfcdi",
    "VSwitchIds" : [ "vsw-2ze6yqnc19*****psjj0j" ],
    "InstanceId" : "sc_flinkserverlesspost_public_cn-0ju2bj2****",
    "ChargeType" : "PRE",
    "InstanceName" : "vvp1",
    "Uid" : "1838996687368452",
    "OrderState" : "NORMAL",
    "ResourceId" : "b3690a1655da47",
    "Storage" : {
      "Oss" : {
        "Bucket" : "oss_flink"
      }
    },
    "ResourceSpec" : {
      "Cpu" : 10,
      "MemoryGB" : 40
    },
    "ClusterStatus" : "RUNNING"
  } ]
}