1. 接口描述
接口请求域名: oceanus.tencentcloudapi.com 。
查询集群
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeClusters。 |
Version | 是 | String | 公共参数,本接口取值:2019-04-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterIds.N | 否 | Array of String | 按照一个或者多个集群 ID 查询,每次请求的集群上限为 100 示例值:cluster-xxxx |
Offset | 否 | Integer | 偏移量,默认 0 示例值:0 |
Limit | 否 | Integer | 请求的集群数量,默认 20,最大值 100 示例值:20 |
OrderType | 否 | Integer | 集群信息结果排序规则,1 按时间降序,2 按照时间升序,3 按照状态排序 示例值:1 |
Filters.N | 否 | Array of Filter | 过滤规则 示例值:[] |
WorkSpaceId | 否 | String | 工作空间 SerialId 示例值:space-1327 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 集群总数 示例值:1 |
ClusterSet | Array of Cluster | 集群列表 示例值:[] |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询集群
查询集群
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusters
<公共请求参数>
{
"ClusterIds": [
"cluster-5c42n3a5"
],
"Limit": 1,
"WorkSpaceId": "space-53rqk422"
}
输出示例
{
"Response": {
"ClusterSet": [
{
"AppId": 1234567890,
"ArchGeneration": 2,
"AutoRenewFlag": 1,
"CCNs": [
{
"CcnId": "",
"SubnetId": "subnet-abcdefghijklmno",
"VpcId": "vpc-pqrstuvwxyz"
}
],
"CLSLogName": "",
"CLSLogSet": "",
"CLSTopicId": "",
"CLSTopicName": "",
"ClusterId": "cluster-abcd1234",
"ClusterSessions": [
{
"AppId": 1234567890,
"ClusterGroupSerialId": "cluster-abcd1234",
"CreateTime": "2023-11-14 18:07:53",
"CreatorUin": "100012345678",
"CuNum": 3,
"FlinkVersion": "Flink-1.13",
"JobManagerCuSpec": 1,
"OwnerUin": "100098765432",
"Properties": [
{
"Key": "pipeline.max-parallelism",
"Value": "2048"
}
],
"Region": "ap-guangzhou",
"Status": 1,
"TaskManagerCuSpec": 1,
"TaskManagerNum": 2,
"UpdateTime": "2023-11-14 18:09:02",
"WebUIUrl": "",
"Zone": "ap-guangzhou-7"
}
],
"ClusterType": 0,
"Correlations": [
{
"ClusterGroupId": 1234,
"ClusterGroupSerialId": "cluster-abcd1234",
"ClusterName": "sample",
"ProjectId": 0,
"ProjectIdStr": "0",
"Status": 2,
"WorkSpaceId": "space-1234567890ap-guangzhou",
"WorkSpaceName": "Default"
}
],
"CreateTime": "2023-08-15 17:18:08",
"CreatorUin": "100012345678",
"CuMem": 4,
"CuNum": 19,
"CustomizedDNSEnabled": 1,
"DefaultCOSBucket": "sample-gz-bucket-1234567890",
"DefaultLogCollectConf": "{\"LogCollectType\":2,\"Conf\":{\"ClsLogsetId\":\"cd9adbb5-6b7d-48d2-9870-77658959c7a4\",\"ClsTopicId\":\"80856bb3-0ef7-4e05-80eb-79ec283bb67d\",\"CosBucket\":\"\"}}",
"ExpireTime": "2023-12-04 15:10:29",
"FreeCu": 9,
"FreeCuNum": 9,
"IsNeedManageNode": 1,
"IsolatedTime": "-",
"Name": "sample",
"NetEnvironmentType": 1,
"Orders": [
{
"AutoRenewFlag": 1,
"ComputeCu": 19,
"OperateUin": "100098765432",
"OrderTime": "2023-11-04 01:57:54",
"Type": 2
}
],
"OwnerUin": "100098765432",
"PayMode": 1,
"Region": "ap-guangzhou",
"Remark": "sample",
"RunningCu": 10,
"SecondsUntilExpiry": "1223380",
"SqlGateways": [],
"Status": 2,
"StatusDesc": "running",
"Tags": [
{
"TagKey": "tag1",
"TagValue": "value1"
},
{
"TagKey": "tag2",
"TagValue": "value2"
}
],
"UpdateTime": "-",
"Version": {
"Flink": "Flink-1.13",
"SupportedFlink": [
"Flink-1.11",
"Flink-1.13",
"Flink-1.14",
"Flink-1.16"
]
},
"WebUIType": 0,
"Zone": "ap-guangzhou-7"
}
],
"RequestId": "24d0cbe8-9bd4-4356-bb95-74c5c4790877",
"TotalCount": 1
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.UnauthorizedOperation | 未授权操作。 |
FailedOperation | 操作失败。 |
FailedOperation.GetResourceTagsByResourceIds | 查询资源关联标签失败。 |
InternalError | 内部错误。 |
InvalidParameterValue.ClusterIds | 群集Id报错。 |
InvalidParameterValue.OrderType | OrderType值错误。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation.NoPermissionAccess | 权限拦截,没有进入权限。 |