重设数据库角色的密码

以下之一：

• Database{21 个属性}

  • objectstringrequired
  • idstringrequired

    pattern: ^db-[0-9a-hjkmnp-tv-z]{16}$
  • namestringrequired

    项目中该名称唯一的数据库；也是它在项目网络中的名称。

  • enginepostgresrequired
  • version16或17或18required

    PostgreSQL 的主版本。

  • regionna或eu或ap或nullrequired

    与创建时指定的一致；null：项目的归属区域。

  • statuscreating或ready或failed或deleting或deletedrequired
  • errorstring | nullrequired

    对于 failed 的数据库：其第一次启动失败的原因。

  • default_branchobjectrequired{19 个属性}

    数据库的一个分支：一个有状态的实例和一个云盘。根分支 main，或数据库自己的分支 (slice DB6)：即其父分支云盘的一个分叉。

    • objectstringrequired
    • idstringrequired

      pattern: ^br-[0-9a-hjkmnp-tv-z]{16}$
    • namestringrequired
    • parentstring | nullrequired

      创建它所依据的分支，按 id；根分支没有。

    • endpointstringrequired

      其端点的名称，命名方式与 Neon 相同：随机生成，这样地址中就不会出现数据库或项目的任何名称。

      pattern: ^ep-[a-z]+-[a-z]+-[0-9a-f]{8}$
    • statecreating或failed或awake或paused或asleep或unavailable另有 2 个required

      其实例的状态：运行时为 awake，暂停层级把它保存在内存中时为 paused，已保存时为 asleep；其节点连不上（或它没有实例）时为 unavailable；数据库还没有实例或没能创建实例时为 creating 和 failed。删除过程中为 deleting，删除后为 deleted。

    • hoststring | nullrequired

      其公开地址，即在数据库所在区域和 DNS 区域下的端点：<endpoint>.<region>.<zone> (ep-calm-river-1a2b3c4d.na.db.glac.run)，端口 5432，只用 TLS；在有边缘节点提供 PostgreSQL 服务时（控制平面的 --database-zone）才有，没有时，或数据库没有可用于命名的区域时，为 null。

    • pooler_hoststring | nullrequired

      其连接池的公开地址（其实例中的 PgBouncer）：<endpoint>-pooler.<region>.<zone>，端口 5432；在有边缘节点提供 PostgreSQL 服务时（控制平面的 --database-zone）才有，没有时，或数据库没有可用于命名的区域时，为 null。

    • connection_uristring | nullrequired

      客户端通过其公开地址连接的方式：postgresql://<owner>@<host>/<database>?sslmode=require，只有给出密码的响应（创建、重设）中才带有所有者的密码；数据库自己的分支使用其父分支的密码；在有边缘节点提供 PostgreSQL 服务时（控制平面的 --database-zone）才有，没有时，或数据库没有可用于命名的区域时，为 null。

    • pooled_uristring | nullrequired

      通过其连接池连接，方式相同：postgresql://<owner>@<pooler_host>/<database>?sslmode=require；在有边缘节点提供 PostgreSQL 服务时（控制平面的 --database-zone）才有，没有时，或数据库没有可用于命名的区域时，为 null。

    • private_hoststringrequired

      它在项目网络中的名称：根分支为数据库的名称；数据库自己的分支为 <database>-<branch>。

    • private_uristringrequired

      项目中的沙箱和服务连接它的方式：postgresql://<owner>@<private_host>:5432/<database>，只有给出密码的响应（创建、重设）中才带有所有者的密码。数据库自己的分支使用其父分支的角色和密码。

    • sizeobjectrequired{2 个属性}

      其实例的上限；按实际用量计费。

      • vcpusintegerrequired
      • memory_bytesintegerrequired

      }
    • storageobjectrequired{5 个属性}

      其云盘 (GET /v1/drives/{drive_id})。

      • drive_idstring | nullrequired
      • size_bytesinteger | nullrequired

        与创建时给出的一致；null：云盘的默认值。

      • durabilitystrict或standardrequired

        其云盘的级别，以其节点的说法为准：strict（提交在对象存储收到后才返回）或 standard。

      • used_bytesinteger | nullrequired

        其云盘中的数据量，以其节点最后一次的说法为准；节点报告之前为 null。

      • billed_bytesinteger | nullrequired

        其云盘保存数据的计费依据：根分支为其中的数据量；数据库自己的分支为分叉以来变化的数据（以回收程序最近一次的计算为准：其最新版本从对象存储中自己的对象读取的数据量），从不超过其中的数据量：回收程序报告之前为 0。没有任何报告之前为 null。

      }
    • app_idstring | nullrequired

      其应用 (GET /v1/apps/{app_id})，创建后才有。

    • instance_idstring | nullrequired

      其实例，即一个沙箱（/v1/sandboxes/{instance_id}：可以读取它、在其中运行命令），如果有的话。

    • start_commandrequired{2 个变体}

      其服务器的运行情况，以其实例所在节点的说法为准（实例的 start_command，见 sandboxd/openapi/openapi.json 中的 SandboxStartCommand）：status（running；restarting：已结束，将在 restarting_at 重新启动；exited）、restarts（结束后在其虚拟机中被重新启动了多少次，数据保持原样：PostgreSQL 靠其 WAL 恢复）、last_exit（status、signal、at）、restarting_at。每次启动还会产生一个事件 instance.restarted。没有实例，或其节点尚未报告时为 null。

      以下之一：

      • InstanceStartCommand
      • null

      }
    • expires_atstring | nullrequired

      自动删除的时间（前提是已没有从它创建的分支）：根分支，以及创建时没有设置它的分支，永不自动删除。

      format: date-time
    • created_atstringrequired

      format: date-time

    }
  • database_namestringrequired

    集群中的数据库（默认 glacdb，除非创建时指定了别的）。

  • rolestringrequired

    其所有者 <database_name>_owner：glac_superuser 的成员，不是超级用户。

  • passwordstring | nullrequired

    所有者的密码，只出现在创建和重设的响应中；其他情况为 null。不保存在任何地方。

  • sleep_after_secondsintegerrequired

    没有任何请求多久后其实例进入休眠，单位为秒。

  • suspend_after_secondsinteger | nullrequired

    暂停多少秒后保存其实例（以及每个分支的实例）的内存并进入休眠（节点会把它限制在十分钟以内）。在此功能之前创建的数据库为 null：使用其节点的最长时间。

  • wake_daily_atstring | nullrequired

    休眠期间每天唤醒它（以及每个分支）的 UTC 时刻；null：不唤醒。

  • metadata映射，值为stringrequired
  • final_snapshotobject | nullrequired{2 个属性}

    已删除的数据库：保留的云盘快照（项目的一个云盘快照）及其删除时间。

    • idstringrequired
    • expires_atstring | nullrequired

    }
  • created_atstringrequired

    format: date-time
  • tieringobjectrequired{2 个属性}

    分层存储：是否开启，以及当前的计费依据。

    • enabledbooleanrequired
    • tiered_bytesintegerrequired

      分层存储当前的计费依据：其各分支以分层形式指向的文件在迁移之前的大小（每个分区交换时的 pg_table_size），每个文件无论被多少分支指向都只计一次，且从不低于其前缀在对象存储中保存的数据量。没有任何分层数据时为 0。

    }
  • history_secondsintegerrequired

    根分支最多能按时间恢复到多久以前，或从多久以前创建分支 (slice DB8)：默认一天，除非创建时另有指定 (history_seconds)；付费套餐上为 0（不保留）到 30 天，免费版为一天（固定，旧数据最多 1 GB：超出时最旧的版本会被删除）。最近一天由其根分支云盘自己的版本窗口提供，每个有写入的 30 秒一个版本（POST /v1/databases/{id}/branches/{branch}/restore，带上 at）；更早的、精确到秒的恢复则由其 WAL 归档提供（slice DB5：exact）。不计费：数据库最近一天的历史是免费的。

    maximum: 2592000 · minimum: 0
  • historyobjectrequired{3 个属性}

    其历史的当前状况。

    • fromstring | nullrequired

      其根分支现在最早能恢复到的时间，取其云盘版本窗口和 WAL 归档中能追溯得更早的那个（在 history_seconds 之内）；如果其 WAL 已归档，则为其创建时间（归档的第一个基础备份就是它启动时所用镜像的初始数据）；否则在其云盘版本窗口有版本之前为 null（数据库就绪后约三分钟）。

      format: date-time
    • stored_bytesintegerrequired

      其根分支版本窗口中的各版本保存的、而最新版本没有的数据（不计费：最近一天是免费的）。

      format: int64 · minimum: 0
    • gaps数组，元素为objectrequired{4 个属性}

      其历史范围内 WAL 归档的缺口，最旧的在前：归档的网关长时间拒绝其 WAL，等待中的 WAL 超出了其云盘为日志保留的空间，为了让数据库保持运行而放弃了这些 WAL。缺口内的时间只能从其根分支云盘的版本窗口恢复（整分钟，或某个版本自身的时间，且在窗口保留期内）；精确到秒或带 exact 时会被拒绝 (400 invalid_history)，从不退而使用它之前的版本。为空：没有缺口。

      • fromstringrequired

        被放弃的 WAL 开始的时间。

        format: date-time
      • tostring | nullrequired

        归档在何时之前无法恢复任何时间：即缺口之后第一个基础备份结束的时间（归档重新接收 WAL 后，在数据库运行时立即创建）；在有这个备份之前为 null。

        format: date-time
      • from_lsnstringrequired

        被放弃的 WAL 在日志中的起始位置 (0/5000000)。

      • to_lsnstringrequired

        结束位置：从那里起归档重新保存 WAL。

      }

    }

  }
• DatabaseRoleSecret{8 个属性}

  • objectstringrequired
  • database_idstringrequired
  • namestringrequired
  • ownerbooleanrequired
  • passwordstringrequired

    新密码：字母和数字，连接字符串可以原样使用。

  • connection_uristring | nullrequired

    带有该角色及其密码的根分支公开地址 (sslmode=require)；没有边缘节点提供 PostgreSQL 服务时为 null。

  • pooled_uristring | nullrequired

    通过其连接池的地址，同上。

  • private_uristring | nullrequired

    它在项目网络中的地址，端口 5432，带有该角色及其密码。

  }