全部产品
Search

搜索本产品

    表格存储：ListInstances - 获取实例列表

    文档中心

    表格存储：ListInstances - 获取实例列表

    更新时间：Nov 12, 2024

    获取实例列表。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    当前API暂无授权信息透出。

    请求语法

    GET /v2/openapi/listinstances HTTP/1.1

    请求参数

    名称类型必填描述示例值
    Statusstring否

    实例状态。

    • normal：正常。
    • forbidden：禁用。
    • deleting：释放中。
    		normal
    MaxResultsinteger否

    返回实例的最大个数，取值范围为 0~200。不设置此参数或者设置为 0 时，则默认值为 100。

    		100
    NextTokenstring否

    查询凭证（Token），取值为上一次 API 调用返回的 NextToken 参数值。从 NextToken 开始按字典序返回实例列表。第一次调用此接口时，设置为空。

    		CAESCG15aC1xxxxx
    InstanceNamestring否

    实例名称，支持模糊搜索。

    		instance
    ResourceGroupIdstring否

    资源组 ID，可通过资源组控制台查询。

    		rg-aek24upgom6p5ri
    InstanceNameListarray否

    实例名称列表，用于批量查询多个指定实例。

    string否

    实例名称，精准匹配查询。

    		instance-test

    返回参数

    名称类型描述示例值
    object

    返回结构体。

    RequestIdstring

    请求 ID，可用于排查和定位问题。

    		E734979F-5A44-5993-9CE5-C23103576923
    TotalCountlong

    返回实例的总条数。

    		2
    NextTokenstring

    当预期返回的实例总数大于设置的 MaxResults 时，将作为查询后续页的凭证。只有当实例未全部返回时，此参数才有值。

    		CAESCG15aC1xxxxx
    Instancesarray<object>

    实例信息列表。

    Instancesobject

    实例对象。

    InstanceNamestring

    实例名称，用于唯一标识一个实例。

    		instance-test
    ResourceGroupIdstring

    资源组 ID。

    		rg-acfmxh4em5jnbcd
    RegionIdstring

    地域 ID。

    		cn-huhehaote
    SPInstanceIdstring

    实例 ID。

    		ots_standard_public_cn-g4t3igqjj002
    AliasNamestring

    实例别名。

    		instance-test
    UserIdstring

    用户 ID。

    		13542356466
    InstanceDescriptionstring

    实例描述。

    		测试实例的描述信息。
    InstanceSpecificationstring

    实例规格。

    • SSD：高性能。
    • HYBRID：容量型。
    		HYBRID
    PaymentTypestring

    付费方式。

    • Subscription：包年包月。
    • PayAsYouGo：按量付费。
    		Subscription
    StorageTypestring

    存储类型。

    • SSD：高性能。
    • HYBRID：容量型。
    		HYBRID
    VCUQuotainteger

    VCU 配额。

    		3
    InstanceStatusstring

    实例状态。

    		normal
    CreateTimestring

    实例的创建时间。

    		2019-04-07T09:19:21Z

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "E734979F-5A44-5993-9CE5-C23103576923",
  "TotalCount": 2,
  "NextToken": "CAESCG15aC1xxxxx",
  "Instances": [
    {
      "InstanceName": "instance-test",
      "ResourceGroupId": "rg-acfmxh4em5jnbcd",
      "RegionId": "cn-huhehaote",
      "SPInstanceId": "ots_standard_public_cn-g4t3igqjj002",
      "AliasName": "instance-test",
      "UserId": "13542356466",
      "InstanceDescription": "测试实例的描述信息。",
      "InstanceSpecification": "HYBRID",
      "PaymentType": "Subscription",
      "StorageType": "HYBRID",
      "VCUQuota": 3,
      "InstanceStatus": "normal",
      "CreateTime": "2019-04-07T09:19:21Z"
    }
  ]
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-07-24OpenAPI 入参发生变更查看变更详情