1. 接口描述
接口请求域名: emr.tencentcloudapi.com 。
查询集群实例信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstances。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-03。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DisplayStrategy | 是 | String | 集群筛选策略。取值范围: 示例值:clusterList |
InstanceIds.N | 否 | Array of String | 按照一个或者多个实例ID查询。实例ID形如: emr-xxxxxxxx 。(此参数的具体格式可参考API简介的 Ids.N 一节)。如果不填写实例ID,返回该APPID下所有实例列表。 示例值:["emr-p9f700x8\r\n"] |
Offset | 否 | Integer | 页编号,默认值为0,表示第一页。 示例值:0 |
Limit | 否 | Integer | 每页返回数量,默认值为100,最大值为100。 示例值:10 |
ProjectId | 否 | Integer | 建议必填-1,表示拉取所有项目下的集群。 不填默认值为0,表示拉取默认项目下的集群。 实例所属项目ID。该参数可以通过调用 DescribeProjects 的返回值中的 projectId 字段来获取。 示例值:0 |
OrderField | 否 | String | 排序字段。取值范围: 示例值:clusterid |
Asc | 否 | Integer | 按照OrderField升序或者降序进行排序。取值范围: 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCnt | Integer | 符合条件的实例总数。 示例值:1 |
ClusterList | Array of ClusterInstancesInfo | EMR实例详细信息列表。 注意:此字段可能返回 null,表示取不到有效值。 |
TagKeys | Array of String | 实例关联的标签键列表。 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例详情
查询实例详情
输入示例
POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{
"DisplayStrategy": "clusterList",
"ProjectId": "0",
"Asc": "0",
"Limit": "10",
"OrderField": "clusterid",
"Offset": "0",
"InstanceIds": [
"emr-p9f700x8"
]
}
输出示例
{
"Response": {
"TotalCnt": 0,
"ClusterList": [
{
"Id": 0,
"ClusterId": "abc",
"Ftitle": "abc",
"ClusterName": "abc",
"RegionId": 0,
"ZoneId": 0,
"AppId": 0,
"Uin": "abc",
"ProjectId": 0,
"VpcId": 0,
"SubnetId": 0,
"Status": 0,
"AddTime": "abc",
"RunTime": "abc",
"Config": {
"SoftInfo": [
"abc"
],
"MasterNodeSize": 0,
"CoreNodeSize": 0,
"TaskNodeSize": 0,
"ComNodeSize": 0,
"MasterResource": {
"Spec": "abc",
"SpecName": "abc",
"StorageType": 0,
"DiskType": "abc",
"RootSize": 0,
"MemSize": 0,
"Cpu": 0,
"DiskSize": 0,
"InstanceType": "abc"
},
"CoreResource": {
"Spec": "abc",
"SpecName": "abc",
"StorageType": 0,
"DiskType": "abc",
"RootSize": 0,
"MemSize": 0,
"Cpu": 0,
"DiskSize": 0,
"InstanceType": "abc"
},
"TaskResource": {
"Spec": "abc",
"SpecName": "abc",
"StorageType": 0,
"DiskType": "abc",
"RootSize": 0,
"MemSize": 0,
"Cpu": 0,
"DiskSize": 0,
"InstanceType": "abc"
},
"OnCos": true,
"ChargeType": 0,
"RouterNodeSize": 0,
"SupportHA": true,
"SecurityOn": true,
"SecurityGroup": "abc",
"CbsEncrypt": 0,
"ApplicationRole": "abc",
"SecurityGroups": [
"abc"
],
"PublicKeyId": "abc"
},
"MasterIp": "abc",
"EmrVersion": "abc",
"ChargeType": 0,
"TradeVersion": 0,
"ResourceOrderId": 0,
"IsTradeCluster": 0,
"AlarmInfo": "abc",
"IsWoodpeckerCluster": 0,
"MetaDb": "abc",
"Tags": [
{
"TagKey": "abc",
"TagValue": "abc"
}
],
"HiveMetaDb": "abc",
"ServiceClass": "abc",
"AliasInfo": "abc",
"ProductId": 0,
"Zone": "abc",
"SceneName": "abc",
"SceneServiceClass": "abc",
"SceneEmrVersion": "abc",
"DisplayName": "abc",
"VpcName": "abc",
"SubnetName": "abc",
"ClusterExternalServiceInfo": [
{
"DependType": 0,
"Service": "abc",
"ClusterId": "abc",
"ClusterStatus": 0
}
],
"UniqVpcId": "abc",
"UniqSubnetId": "abc",
"TopologyInfoList": [
{
"ZoneId": 0,
"Zone": "abc",
"SubnetInfoList": [
{
"SubnetName": "abc",
"SubnetId": "abc"
}
],
"NodeInfoList": [
{
"NodeType": "abc",
"NodeSize": 1
}
]
}
],
"IsMultiZoneCluster": true,
"IsCvmReplace": true
}
],
"TagKeys": [
"abc"
],
"RequestId": "abc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.DescribeResourceTagsFailed | 拉取资源标签失败 |
FailedOperation.GetCamRoleFailed | 获取cam角色失败。 |
FailedOperation.GetCamServerFailed | 调用cam服务失败。 |
InternalError | 内部错误。 |
InternalError.AccountCgwError | 内部服务调用异常。 |
InternalError.CamCgwError | 内部服务调用异常。 |
InternalError.CamError | 内部服务调用异常。 |
InternalError.CbsCgwError | 内部服务调用异常。 |
InternalError.CbsError | 内部服务调用异常。 |
InternalError.CdbCgwError | 内部服务调用异常。 |
InternalError.CdbError | 内部服务调用异常。 |
InternalError.ConfigCgwError | 内部服务调用异常。 |
InternalError.CvmError | 内部服务调用异常。 |
InternalError.KmsError | 内部服务调用异常。 |
InternalError.ProjectCgwError | 内部服务调用异常。 |
InternalError.SgError | 安全组接口调用异常。 |
InternalError.TagError | 内部服务调用异常。 |
InternalError.TradeCgwError | 内部服务调用异常。 |
InternalError.VpcCgwError | 内部服务调用异常。 |
InternalError.VpcError | 内部服务调用异常。 |
InternalError.WoodServerError | 内部服务调用异常。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DisplayStrategyNotMatch | 展示策略错误。 |
InvalidParameter.InvalidClusterId | 无效参数,ClusterId。 |
InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
InvalidParameter.OrderFieldNotMatch | 排序字段错误。 |
ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
ResourceNotFound.HardwareInfoNotFound | 无法找到硬件信息。 |
ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
UnauthorizedOperation.CheckCamAuth | 校验账号操作无权限。 |