1. 接口描述
接口请求域名: emr.tencentcloudapi.com 。
本接口(DescribeSLInstance)用于查询 Serverless HBase实例基本信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSLInstance。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-03。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-nanjing, ap-shanghai, eu-frankfurt 。 |
InstanceId | 是 | String | 实例唯一标识符(字符串表示) 示例值:emr-xxxxxxxx |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例字符串标识。 示例值:emr-xxxxxxxx |
InstanceName | String | 实例名称。 示例值:emr-test |
PayMode | Integer | 实例计费模式。0表示后付费,即按量计费,1表示预付费,即包年包月。 示例值:0 |
DiskType | String | 实例存储类型。 示例值:CLOUD_HSSD |
DiskSize | Integer | 实例单节点磁盘容量,单位GB。 示例值:100 |
NodeType | String | 实例节点规格。 示例值:4核16G |
ZoneSettings | Array of ZoneSetting | 实例可用区详细配置,包含可用区名称,VPC信息、节点数量。 |
Tags | Array of Tag | 实例绑定的标签列表。 注意:此字段可能返回 null,表示取不到有效值。 |
ClusterId | Integer | 实例数字标识。 示例值:11111111 |
RegionId | Integer | 实例区域ID。 示例值:1 |
Zone | String | 实例主可用区。 示例值:ap-guangzhou-2 |
ExpireTime | String | 实例过期时间,后付费返回0000-00-00 00:00:00 示例值:0000-00-00 00:00:00 |
IsolateTime | String | 实例隔离时间,未隔离返回0000-00-00 00:00:00。 示例值:0000-00-00 00:00:00 |
CreateTime | String | 实例创建时间。 示例值:0000-00-00 00:00:00 |
Status | Integer | 实例状态码,-2: "TERMINATED", 2: "RUNNING", 14: "TERMINATING", 19: "ISOLATING", 22: "ADJUSTING", 201: "ISOLATED"。 示例值:2 |
AutoRenewFlag | Integer | 自动续费标记, 0:表示通知即将过期,但不自动续费 1:表示通知即将过期,而且自动续费 2:表示不通知即将过期,也不自动续费,若业务无续费概念为0 示例值:0 |
NodeNum | Integer | 实例节点总数。 示例值:3 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 Serverless HBase查询实例信息
Serverless HBase查询实例信息
输入示例
POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSLInstance
<公共请求参数>
{
"InstanceId": "emr-3o9tms4i"
}
输出示例
{
"Response": {
"DiskSize": 100,
"DiskType": "性能云存储",
"InstanceName": "sl-haoyuhua-test-create",
"NodeType": "4C16G",
"PayMode": 0,
"RequestId": "a316989f-9316-4205-a2a3-64ab841aee14",
"ZoneSettings": [
{
"NodeNum": 1,
"VPCSettings": {
"SubnetId": "subnet-5bhc4kly",
"VpcId": "vpc-dcfhrh73"
},
"Zone": "ap-guangzhou-2"
},
{
"NodeNum": 1,
"VPCSettings": {
"SubnetId": "subnet-5bhc4kly",
"VpcId": "vpc-dcfhrh73"
},
"Zone": "ap-guangzhou-2"
},
{
"NodeNum": 1,
"VPCSettings": {
"SubnetId": "subnet-5bhc4kly",
"VpcId": "vpc-dcfhrh73"
},
"Zone": "ap-guangzhou-2"
}
]
}
}
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.RefundCvmFailed | 操作失败。 |
InternalError | 内部错误。 |
InternalError.CamCgwError | 内部服务调用异常。 |
InternalError.CvmError | 内部服务调用异常。 |
InvalidParameter | 参数错误。 |
InvalidParameter.InvalidAppId | 无效参数,AppId。 |
InvalidParameter.InvalidClusterId | 无效参数,ClusterId。 |
InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
InvalidParameter.InvalidZone | 无效的可用区。 |
ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
ResourceUnavailable.ResourceSpecNotExist | 资源规格不存在。 |
UnauthorizedOperation.CheckCamAuth | 校验账号操作无权限。 |
UnsupportedOperation.ServiceNotSupport | 该服务不支持此操作。 |