获取实例详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dms:GetInstance | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Tid | long | 否 | 租户 ID，可通过调用接口 GetUserActiveTenant 获取该参数的值。 | 2*** |
| Host | string | 是 | 实例连接地址，可通过调用接口 ListInstances 获取该参数的值。 | 172.17.XXX.XXX |
| Port | integer | 是 | 实例连接端口，可通过调用接口 ListInstances 获取该参数的值。 | 5432 |
| Sid | string | 否 | 实例 Sid，可调用接口 ListInstances 获取该参数的值。 | test |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "F6C80B69-3203-56AC-8021-18BA72A6F4E1",
"Instance": {
"VpcId": "vpc-o6wrloqsdqc9io3mg****",
"DatabaseUser": "dbuser",
"DbaId": "29****",
"UseDsql": 0,
"Port": 5432,
"EcsInstanceId": "i-bp124ldpklqz59y3****",
"EnvType": "test",
"Sid": "test",
"OwnerIdList": {
"OwnerIds": [
"10****"
]
},
"SafeRuleId": "3****",
"OwnerNameList": {
"OwnerNames": [
"yang_test"
]
},
"DbaNickName": "dbaname",
"QueryTimeout": 7200,
"InstanceSource": "ECS_OWN",
"Host": "192.168.XXX.XXX",
"State": "NORMAL",
"DataLinkName": "test",
"ExportTimeout": 86400,
"InstanceId": "188****",
"InstanceType": "postgresql",
"DatabasePassword": "******",
"InstanceAlias": "测试",
"DdlOnline": 0,
"EcsRegion": "cn-beijing",
"StandardGroup": {
"GroupName": "自由操作",
"GroupMode": "NONE_CONTROL"
},
"SellSitd": false,
"SellTrust": ""
},
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史