查看表详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gpdb:DescribeTable | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 否 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 版实例的详情，包括实例 ID。
| gp-xxxxxxxxx |
| WorkspaceId | string | 否 | 多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空，当和 DBInstanceId 同时指定时以此参数为准。 | gp-ws-***** |
| RegionId | string | 是 | 实例所在的地域 ID。 | cn-beijing |
| SecretArn | string | 是 | 访问凭证。通过 CreateSecret 接口创建。 说明
通过子账号访问此接口时，需要有对此 SecretArn 的 UseSecret 或 GetSecretValue 的权限。
| acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ |
| Database | string | 是 | 数据库名称。 | adbtest |
| Schema | string | 是 | 表所在的 Schema 的名称。 | public |
| Table | string | 是 | 表名称。 | mytable |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "success",
"Status": "success",
"ColumnList": {
"ColumnList": [
{
"Name": "",
"DataType": "",
"ColumnDefault": "",
"MaxLength": 0,
"Nullable": true,
"SchemaName": "",
"TableName": "",
"IsCaseSensitive": true,
"IsCurrency": true,
"IsSigned": true,
"Precision": 0,
"Scale": 0,
"IsPrimaryKey": true,
"Comment": "",
"UdtName": ""
}
]
}
}错误码
访问错误中心查看更多错误码。