通过指定的实例ID查看实例详情。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
searchengine:GetInstance | Read |
|
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
instanceId | string | 是 | 实例 ID。 | ha-cn-7pp2pcna701 |
返回参数
返回示例
正常返回示例
{
"requestId": "90D6B8F5-FE97-4509-9AAB-367836C51818",
"result":
{
"instanceId":"fadsfsafs",
"inDebt":true,
"lockMode":"Unlock",
"expiredTime":"asdfas",
"updateTime":"dfasf",
"createTime":"dfasf",
"resourceGroupId":"resourceGroupID",
"commodityCode":"commodityCode",
"chargeType":"POSYPAY",
"description":"this is description",
"apiVersion": "tisplus/v1",
"network": {
"vSwitchId": "vswitch_id_xxx",
"vpcId": "vpc_id_xxx",
},
"userName": "user",
"spec": {
"searchResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
},
"qrsResource": {
"disk": 50,
"mem": 8,
"cpu": 2,
"nodeCount": 2
}
},
"status": "INIT",
}
}
异常返回示例
{
"requestId": "BD1EA715-DF6F-06C2-004C-C1FA0D3A9820",
"httpCode": 404,
"code": "App.NotFound",
"message": "App not found"
}
示例
正常返回示例
JSON
格式
{
"result": {
"description": "ha3_test",
"resourceGroupId": "rg-aekzjvw24el5lma",
"expiredTime": "1634609702",
"commodityCode": "commodityCode",
"instanceId": "ha-cn-7mz2qsgq301",
"createTime": "2022-06-17T02:01:26Z",
"lockMode": "Unlock",
"chargeType": "POSYPAY",
"updateTime": "1634609702",
"inDebt": false,
"status": "INIT",
"tags": [
{
"key": "env",
"value": "prod"
}
]
},
"requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-01-12 | 新增 OpenAPI | 看变更集 |