获取订单列表

获取订单列表

Query Parameters

filter string

列表筛选条件 支持用户名、订单编号、产品服务 订单开始/结束日期筛选，如：creator_name="xue" AND id="67" AND create_time>="2023-12-01" AND create_time<="2024-02-01"

order_by string

排序结果

page_size int32

返回当前页的最大条目数

page_token string

从上一个List请求返回的next_page_token值

resource_instance_id string

资源实例 uuid

resource_type string[]

资源类型

contract_display_name string

资源包/合同包名称

resource_name string

资源标识

resource_display_name string

资源名称

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

orders object[] required
订单列表
Array [
id string required
订单ID
subscription_id string required
订阅ID
resource_group_id string
资源组ID
type enum required
Possible values: [OT_UNSPECIFIED, OT_ORIGINAL, OT_RENEW, OT_UPGRADED, OT_DOWNGRADED, OT_CONTRACT, OT_UNSUBSCRIBE, OT_RESIZE]
订单类型
start_time date-time required
开始时间
end_time date-time required
结束时间
auto_renew boolean required
是否自动续订
original_id string required
原始订单ID
amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
original_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
discount_amount object required
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
coupon_amount object required
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
voucher_amount object required
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
pay enum required
Possible values: [PC_UNSPECIFIED, PC_BALANCE, PC_CREDIT, PC_FROZENACCOUNT, PC_REMIT_OFFLINE, PC_ALIPAY, PC_UNIONPAY, PC_REMIT_ONLINE, PC_CONTRACT, PC_WECHAT]
支付方式
note string
备注信息
currency_code string required
币种
details object[] required
订单详情
Array [
id string required
订单详情ID
order_id string required
归属的订单ID
sku object required
最小库存单元
spu_id string required
隶属标准化产品单元id
display_name string required
最小库存单元名称
regions string[] required
可售卖区域
available_zones string[] required
可售卖可用区
business_billing_cycle enum required
Possible values: [BBC_UNSPECIFIED, BBC_HOURLY, BBC_DAILY, BBC_WEEKLY, BBC_MONTHLY, BBC_QUARTERLY, BBC_YEARLY]
计费周期， 默认每小时;
billing_cycle enum required
Possible values: [BC_UNSPECIFIED, BC_HOURLY, BC_DAILY, BC_WEEKLY, BC_MONTHLY, BC_QUARTERLY, BC_YEARLY]
账单周期， 默认按月出账;
billing_cycle_number int32 required
账单周期数
payment_model enum required
Possible values: [PM_UNSPECIFIED, PM_PREPAID, PM_POSTPAID]
付费模式
billing_model enum required
Possible values: [BM_UNSPECIFIED, BM_USAGE, BM_MONTHLY, BM_YEARLY]
计费模式
price_model enum required
Possible values: [PIM_UNSPECIFIED, PIM_FLATFEE, PIM_PERUNIT, PIM_TIERED, PIM_VOLUME, PIM_STAIRSTEP]
计费模型
price object[] required
价格
Array [
tier int32
层次
name string
层次名称
max_value int64
每层最大值
money object[]
价格
Array [
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
]
price_unit string required
价格单位
price_scale int64 required
价格上报尺度
stock int64 required
库存数量
stock_unit string required
库存单位
discount int32 required
折扣, 从0-100, 100表示不打折
max_quantity int64
最多可售卖数量
min_quantity int64
最少可售卖数量
have_trial boolean
是否含有试用期
trial_count int64
试用数量
trial_unit string
试用单位
effective_time date-time required
生效时间(已弃用)
ineffective_time date-time required
失效时间(已弃用)
one_time boolean
是否只能购买一次
cancel_policy enum
Possible values: [SP_UNSPECIFIED, SP_IMMEDIATELY, SP_ENDOFTERM, SP_UNCONDITIONALLY_REFUND, SP_NONREFUNDABLE]
退订规则
actions string[]
此字段已弃用
tags string[]
此字段已弃用
excess_sku_id string
此字段已弃用
attributes object[]
关联的规格和描述属性
Array [
attribute_id string
属性id
display_name string
属性名称
property_name string
属性后端名称
value string
属性值
value_unit string
属性单位
value_scale int64
value scale
attribute_value_id string
属性值id
attribute_type enum
Possible values: [ATT_KEY, ATT_SPEC, ATT_DESCRIPTION, ATT_BILLING_ITEM]
属性类型
]
sku_billing_items object[] required
关联的计费项
Array [
id string required
计费项id
sku_id string required
最小库存单元id
attribute_id string required
关联计费属性id
value_unit string required
属性单位
price_model enum required
Possible values: [PIM_UNSPECIFIED, PIM_FLATFEE, PIM_PERUNIT, PIM_TIERED, PIM_VOLUME, PIM_STAIRSTEP]
价格模型
price object[] required
价格
Array [
tier int32
层次
name string
层次名称
max_value int64
每层最大值
money object[]
价格
Array [
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
]
price_unit string required
价格单位
price_scale int64 required
价格尺度
stock int64 required
库存
stock_unit string required
库存单位
max_quantity int64 required
计费项数量上限
min_quantity int64 required
计费项数量下限
value_scales object[]
单位换算关系
Array [
value_unit string
属性单位
value_scale int64
换算倍数
attribute_value_id string
属性值id
]
status enum required
Possible values: [ST_UNSPECIFIED, ST_RELEASE, ST_UNRELEASED]
状态
discount int32 required
折扣
meter_unit string required
计量上报单位
]
meter_unit string required
计量上报单位
usage_scope_type enum
Possible values: [UST_UST_UNSPECIFIED, UST_PUBLIC, UST_SPECIFIED]
适用类型
usage_scope_tenant_ids string[]
适用租户IDs
usage_scope_editable boolean
适用是否可编辑
order_billing_items object[] required
计费项
Array [
id string required
ID
billing_item_id string required
计费项ID
number int64 required
计费项数量
price object[]
价格
Array [
tier int32
层次
name string
层次名称
max_value int64
每层最大值
money object[]
价格
Array [
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
]
value_unit string
购买计费项数量
amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
original_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
discount_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
region_code string required
地区
zone string required
可用区
currency_code string required
币种
payment_model enum required
Possible values: [PM_UNSPECIFIED, PM_PREPAID, PM_POSTPAID]
付费模式
price object[]
商品价格
Array [
tier int32
层次
name string
层次名称
max_value int64
每层最大值
money object[]
价格
Array [
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
]
number int32 required
商品购买数量
billing_cycle int32 required
商品购买周期
amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
original_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
discount_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
coupon_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
voucher_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
contract_detail_id string
合同包详情ID
instances object[] required
实例信息
Array [
id string required
ID
resource_instance_id string required
资源实例 uuid
resource_instance_rid string
资源实例 rid
order_detail_id string required
订单详情ID
subscription_name string
订阅名称
resource_group_name string
资源组名称
name string
名称
display_name string
展示名称
]
fulfill_rm_resource_row string
RM侧资源信息
fulfill_rm_message_body string
RM侧消息
fulfill_rm_topic string
RM侧topic
meter_rules object[]
计量规则
Array [
id string required
ID
order_detail_id string required
订单详情ID
tier int32 required
阶梯
max_value int32 required
最大量
price int64 required
单价
]
properties object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
@type string
The type of the serialized message.
property name* any
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
]
name string required
名称
transferred_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
ba_departed_amounts object[]
多BA分摊金额
Array [
billing_account_display_name string
计费账户名称
billing_account_id string
计费账户ID
amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
currency_code string
币种
depart_ratio int32
分摊比例
trans_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
refund_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
original_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
auto_convert_postpaid boolean
到期后是否自动转为后付费
ba_recommend_voucher_instances object[]
续订订单估值时返回的推荐代金券列表
Array [
billing_account_id string
计费账户ID
recommend_voucher_instance object[]
推荐的代金券实例列表
Array [
voucher_instance object
代金券实例
backend_catalogs object[]
限制品类信息列表
Array [
id string required
品类ID create: require, if not assign id, give "" update: require
display_name string required
create: require update: require, can be updated
parent_id string required
create: require, if no parent, value is "00000000-0000-0000-0000-000000000000" update: require, can not be updated
is_leaf boolean required
create: require update: not require, can not be updated
enable boolean required
create: require, default true update: not require
url string required
buy_url string required
backend_catalog_code string required
icon string
dashboard图标
introduction string
official_link string
help_link string
recommended_catalogs string[]
saleable boolean required
create: require, default true update: not require
gray_release boolean required
灰度发布标记
tenant_whitelist string[] required
租户白名单
resource_type_group_ids string[] required
关联RP类型
usage_scope_type enum
Possible values: [UST_UST_UNSPECIFIED, UST_PUBLIC, UST_SPECIFIED]
适用类型
usage_scope_tenant_ids string[]
适用租户IDs
usage_scope_editable boolean
适用是否可编辑
]
denomination_money object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
available_money object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
voucher_intance_transactions object[]
券实例流水信息，券详情使用
Array [
amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
available_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
system_recommend boolean
是否系统自动推荐：true是， false否
deduction_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
max_deduction_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
remaining_amount object
价格
currency_code string
货币代码, 参考ISO 4217
units int64
价格整数部分
nanos int32
价格小数部分
]
]
]
next_page_token string

下一页

total_size int32

总记录

{
  "orders": [
    {
      "id": "string",
      "subscription_id": "string",
      "resource_group_id": "string",
      "subscription_name": "string",
      "resource_group_name": "string",
      "spu_name": "string",
      "billing_day": 0,
      "state": "OS_UNSPECIFIED",
      "type": "OT_UNSPECIFIED",
      "start_time": "2024-11-04T06:28:48.503Z",
      "end_time": "2024-11-04T06:28:48.503Z",
      "auto_renew": true,
      "change_policy": "SP_UNSPECIFIED",
      "cancel_policy": "SP_UNSPECIFIED",
      "original_id": "string",
      "contract_display_name": "string",
      "amount": {
        "currency_code": "string",
        "units": 0,
        "nanos": 0
      },
      "original_amount": {
        "currency_code": "string",
        "units": 0,
        "nanos": 0
      },
      "discount_amount": {
        "currency_code": "string",
        "units": 0,
        "nanos": 0
      },
      "coupon_amount": {
        "currency_code": "string",
        "units": 0,
        "nanos": 0
      },
      "voucher_amount": {
        "currency_code": "string",
        "units": 0,
        "nanos": 0
      },
      "pay": "PC_UNSPECIFIED",
      "note": "string",
      "currency_code": "string",
      "creator": "string",
      "updater": "string",
      "create_time": "2024-11-04T06:28:48.503Z",
      "update_time": "2024-11-04T06:28:48.503Z",
      "details": [
        {
          "id": "string",
          "order_id": "string",
          "sku": {
            "spu_id": "string",
            "id": "string",
            "display_name": "string",
            "regions": [
              "string"
            ],
            "available_zones": [
              "string"
            ],
            "business_billing_cycle": "BBC_UNSPECIFIED",
            "billing_cycle": "BC_UNSPECIFIED",
            "billing_cycle_number": 0,
            "payment_model": "PM_UNSPECIFIED",
            "billing_model": "BM_UNSPECIFIED",
            "price_model": "PIM_UNSPECIFIED",
            "price": [
              {
                "tier": 0,
                "name": "string",
                "max_value": 0,
                "money": [
                  {
                    "currency_code": "string",
                    "units": 0,
                    "nanos": 0
                  }
                ]
              }
            ],
            "price_unit": "string",
            "price_scale": 0,
            "stock": 0,
            "stock_unit": "string",
            "discount": 0,
            "max_quantity": 0,
            "min_quantity": 0,
            "have_trial": true,
            "trial_count": 0,
            "trial_unit": "string",
            "effective_time": "2024-11-04T06:28:48.504Z",
            "ineffective_time": "2024-11-04T06:28:48.504Z",
            "one_time": true,
            "cancel_policy": "SP_UNSPECIFIED",
            "actions": [
              "string"
            ],
            "tags": [
              "string"
            ],
            "excess_sku_id": "string",
            "attributes": [
              {
                "attribute_id": "string",
                "display_name": "string",
                "property_name": "string",
                "value": "string",
                "value_unit": "string",
                "value_scale": 0,
                "attribute_value_id": "string",
                "attribute_type": "ATT_KEY"
              }
            ],
            "status": "ST_UNSPECIFIED",
            "spu_name": "string",
            "sku_billing_items": [
              {
                "id": "string",
                "sku_id": "string",
                "attribute_id": "string",
                "display_name": "string",
                "property_name": "string",
                "value_unit": "string",
                "price_model": "PIM_UNSPECIFIED",
                "price": [
                  {
                    "tier": 0,
                    "name": "string",
                    "max_value": 0,
                    "money": [
                      {
                        "currency_code": "string",
                        "units": 0,
                        "nanos": 0
                      }
                    ]
                  }
                ],
                "price_unit": "string",
                "price_scale": 0,
                "stock": 0,
                "stock_unit": "string",
                "max_quantity": 0,
                "min_quantity": 0,
                "value_scales": [
                  {
                    "value_unit": "string",
                    "value_scale": 0,
                    "attribute_value_id": "string"
                  }
                ],
                "status": "ST_UNSPECIFIED",
                "discount": 0,
                "creator": "string",
                "updater": "string",
                "create_time": "2024-11-04T06:28:48.505Z",
                "update_time": "2024-11-04T06:28:48.505Z",
                "meter_unit": "string"
              }
            ],
            "creator": "string",
            "updater": "string",
            "create_time": "2024-11-04T06:28:48.505Z",
            "update_time": "2024-11-04T06:28:48.505Z",
            "meter_unit": "string",
            "usage_scope_type": "UST_UST_UNSPECIFIED",
            "usage_scope_tenant_ids": [
              "string"
            ],
            "usage_scope_editable": true
          },
          "order_billing_items": [
            {
              "id": "string",
              "billing_item_id": "string",
              "number": 0,
              "property_name": "string",
              "display_name": "string",
              "price_scale": 0,
              "price_model": "PIM_UNSPECIFIED",
              "price": [
                {
                  "tier": 0,
                  "name": "string",
                  "max_value": 0,
                  "money": [
                    {
                      "currency_code": "string",
                      "units": 0,
                      "nanos": 0
                    }
                  ]
                }
              ],
              "discount": 0,
              "value_unit": "string",
              "amount": {
                "currency_code": "string",
                "units": 0,
                "nanos": 0
              },
              "original_amount": {
                "currency_code": "string",
                "units": 0,
                "nanos": 0
              },
              "discount_amount": {
                "currency_code": "string",
                "units": 0,
                "nanos": 0
              }
            }
          ],
          "region_code": "string",
          "zone": "string",
          "currency_code": "string",
          "payment_model": "PM_UNSPECIFIED",
          "price": [
            {
              "tier": 0,
              "name": "string",
              "max_value": 0,
              "money": [
                {
                  "currency_code": "string",
                  "units": 0,
                  "nanos": 0
                }
              ]
            }
          ],
          "number": 0,
          "billing_cycle": 0,
          "amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          },
          "original_amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          },
          "discount_amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          },
          "coupon_amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          },
          "voucher_amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          },
          "free_quantity": 0,
          "state": "OD_UNSPECIFIED",
          "active_time": "2024-11-04T06:28:48.505Z",
          "contract_detail_id": "string",
          "creator": "string",
          "updater": "string",
          "create_time": "2024-11-04T06:28:48.505Z",
          "update_time": "2024-11-04T06:28:48.505Z",
          "instances": [
            {
              "id": "string",
              "resource_instance_id": "string",
              "resource_instance_rid": "string",
              "order_detail_id": "string",
              "start_time": "2024-11-04T06:28:48.505Z",
              "end_time": "2024-11-04T06:28:48.505Z",
              "subscription_name": "string",
              "resource_group_name": "string",
              "name": "string",
              "display_name": "string"
            }
          ],
          "spu_name": "string",
          "fulfill_rm_resource_row": "string",
          "fulfill_rm_message_body": "string",
          "fulfill_rm_topic": "string",
          "meter_rules": [
            {
              "id": "string",
              "order_detail_id": "string",
              "tier": 0,
              "max_value": 0,
              "price": 0
            }
          ],
          "resource_type": "string",
          "properties": {
            "@type": "string"
          }
        }
      ],
      "name": "string",
      "creator_name": "string",
      "unsubscription_reason": "string",
      "cancel_renew_flag": true,
      "initial_id": "string",
      "transferred_amount": {
        "currency_code": "string",
        "units": 0,
        "nanos": 0
      },
      "resource_diff_value": "string",
      "ba_departed_amounts": [
        {
          "billing_account_display_name": "string",
          "billing_account_id": "string",
          "amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          },
          "currency_code": "string",
          "depart_ratio": 0,
          "trans_amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          },
          "refund_amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          },
          "original_amount": {
            "currency_code": "string",
            "units": 0,
            "nanos": 0
          }
        }
      ],
      "contract_ver": "string",
      "auto_convert_postpaid": true,
      "ba_recommend_voucher_instances": [
        {
          "billing_account_id": "string",
          "recommend_voucher_instance": [
            {
              "voucher_instance": {
                "voucher_batch_id": "string",
                "id": "string",
                "display_name": "string",
                "voucher_issue_id": "string",
                "billing_account_id": "string",
                "billing_account_name": "string",
                "tenant_id": "string",
                "tenant_code": "string",
                "tenant_display_name": "string",
                "issue_comment": "string",
                "voucher_type": "VT_DISCOUNT",
                "use_scope": "US_GENERAL",
                "use_case": "UC_GENERAL",
                "use_count": "UC_SINGLE",
                "use_limit": "UL_NO_THRESHOLD",
                "prepaid_limit": "PL_OVERLAY",
                "postpaid_limit": "PL_UNSPECIFIED",
                "max_deductible_ratio": 0,
                "reachable_amount": 0,
                "max_amount_monthly": 0,
                "backend_catalog_id": "string",
                "backend_catalog_name": "string",
                "backend_catalogs": [
                  {
                    "id": "string",
                    "display_name": "string",
                    "parent_id": "string",
                    "is_leaf": true,
                    "level": 0,
                    "order": 0,
                    "enable": true,
                    "url": "string",
                    "buy_url": "string",
                    "resource_types": [
                      "string"
                    ],
                    "have_descendants": true,
                    "backend_catalog_code": "string",
                    "creator": "string",
                    "updater": "string",
                    "create_time": "2024-11-04T06:28:48.507Z",
                    "update_time": "2024-11-04T06:28:48.507Z",
                    "is_favorite": true,
                    "icon": "string",
                    "tags": [
                      "string"
                    ],
                    "introduction": "string",
                    "official_link": "string",
                    "help_link": "string",
                    "recommended_catalogs": [
                      "string"
                    ],
                    "has_resource": true,
                    "saleable": true,
                    "icon_code": "string",
                    "gray_release": true,
                    "tenant_whitelist": [
                      "string"
                    ],
                    "favorite_time": "2024-11-04T06:28:48.507Z",
                    "resource_type_group_ids": [
                      "string"
                    ],
                    "usage_scope_type": "UST_UST_UNSPECIFIED",
                    "usage_scope_tenant_ids": [
                      "string"
                    ],
                    "usage_scope_editable": true
                  }
                ],
                "denomination_value": 0,
                "available_value": 0,
                "denomination_money": {
                  "currency_code": "string",
                  "units": 0,
                  "nanos": 0
                },
                "available_money": {
                  "currency_code": "string",
                  "units": 0,
                  "nanos": 0
                },
                "effective_time": "2024-11-04T06:28:48.507Z",
                "ineffective_time": "2024-11-04T06:28:48.507Z",
                "state": "STATE_UNUSED",
                "issuer_name": "string",
                "creator": "string",
                "updater": "string",
                "create_time": "2024-11-04T06:28:48.507Z",
                "update_time": "2024-11-04T06:28:48.507Z",
                "creator_name": "string",
                "updater_name": "string",
                "recent_consumption_time": "2024-11-04T06:28:48.507Z",
                "voucher_intance_transactions": [
                  {
                    "id": "string",
                    "related_object_type": "TXROT_UNSPECIFIED",
                    "action": "TXI_UNSPECIFIED",
                    "related_object_id": "string",
                    "bill_month": "string",
                    "consumption_time": "2024-11-04T06:28:48.507Z",
                    "voucher_instance_id": "string",
                    "billing_account_id": "string",
                    "amount": {
                      "currency_code": "string",
                      "units": 0,
                      "nanos": 0
                    },
                    "available_amount": {
                      "currency_code": "string",
                      "units": 0,
                      "nanos": 0
                    }
                  }
                ]
              },
              "system_recommend": true,
              "deduction_amount": {
                "currency_code": "string",
                "units": 0,
                "nanos": 0
              },
              "max_deduction_amount": {
                "currency_code": "string",
                "units": 0,
                "nanos": 0
              },
              "remaining_amount": {
                "currency_code": "string",
                "units": 0,
                "nanos": 0
              }
            }
          ]
        }
      ]
    }
  ],
  "next_page_token": "string",
  "total_size": 0
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...