查詢一個或多個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 |
| Tags | array<object> | 否 | 實例的標簽集合。 | |
| object | 否 | 實例標簽 | ||
| Key | string | 否 | 標簽鍵。 | test |
| Value | string | 否 | 標簽的值。 長度限制為 64 Unicode 字符。 | ys |
返回參數
示例
正常返回示例
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,
"ElasticUsedMemory": "",
"ElasticUsedResource": "",
"ElasticUsedCpu": 0,
"GuaranteedUsedMemory": "",
"GuaranteedUsedResource": 0,
"GuaranteedUsedCpu": 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": ""
},
"Elastic": true,
"ElasticResourceSpec": {
"Cpu": 0,
"MemoryGB": 0
},
"ElasticOrderState": ""
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-05 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-07-31 | OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-03-07 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |