GetTable

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	Table name	my_table
ClientToken	string	No	Idempotent token	1e9b8f60-3a2c-4d7e-9f1b-8c3d5e7a2b4f
Catalog	string	No	Data catalog	my_catalog
Namespace	string	No	Namespace	my_namespace

Response elements

Element	Type	Description	Example
	object
Message	string	API response message	Operation success
RequestId	string	Request ID	34AD682D-5B91-5773-8132-AA38C130****
Code	string	Return code	200
Success	boolean	Indicates whether the request was successful	true
Data	Table	Table details

Examples

Success response

JSON format

{
  "Message": "Operation success",
  "RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
  "Code": "200",
  "Success": true,
  "Data": {
    "Catalog": "my_catalog",
    "Namespace": "my_namespace",
    "Name": "my_table",
    "Comment": "测试事件表",
    "CreateTime": 1717948800000,
    "UpdateTime": 1717948800000,
    "RetentionPolicy": {
      "HotTTL": 7,
      "ColdTTL": 30
    },
    "Columns": [
      {
        "Name": "id",
        "Type": "bigint",
        "Comment": "主键ID"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.