服务

组织服务列表

返回组织中所有服务的列表。

方法	路径
GET	/v1/organizations/{organizationId}/services

请求

路径参数

名称	类型	描述
organizationId	uuid	所请求组织的 ID。

响应

响应模式

名称	类型	描述
id	uuid	唯一的服务 ID。
name	string	服务的名称。包含空格的字母数字字符串，最多 50 个字符。
provider	string	云提供商
region	string	服务区域。
state	string	服务的当前状态。
endpoints	array	所有服务端点的列表。
tier	string	服务的层级：“development”、“production”、“dedicated_high_mem”、“dedicated_high_cpu”、“dedicated_standard”、“dedicated_standard_n2d_standard_4”、“dedicated_standard_n2d_standard_8”、“dedicated_standard_n2d_standard_32”、“dedicated_standard_n2d_standard_128”。生产服务进行扩展，开发服务大小固定。Azure 服务不支持开发层级
minTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最小内存（以 GB 为单位）。仅适用于“production”服务。必须是 12 的倍数，且大于或等于 24。
maxTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最大内存（以 GB 为单位）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数，且小于或等于 360；对于付费服务，必须小于或等于 720。
minReplicaMemoryGb	number	自动扩展期间每个副本的最小总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且大于或等于 8。
maxReplicaMemoryGb	number	自动扩展期间每个副本的最大总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且对于非付费服务，必须小于或等于 120；对于付费服务，必须小于或等于 240。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。
ipAccessList	array	允许访问服务的 IP 地址列表
createdAt	date-time	服务创建时间戳。ISO-8601 格式。
encryptionKey	string	可选的客户提供的磁盘加密密钥
encryptionAssumedRoleIdentifier	string	用于磁盘加密的可选角色
iamRole	string	用于访问 s3 中对象的 IAM 角色
privateEndpointIds	array	私有端点列表
dataWarehouseId	string	包含此服务的数据库仓库
isPrimary	string	如果此服务是数据库仓库中的主要服务，则为 true

示例响应

{
  "id": "uuid",
  "name": "string",
  "provider": "string",
  "region": "string",
  "state": "string",
  "endpoints": "Array",
  "tier": "string",
  "minTotalMemoryGb": 0,
  "maxTotalMemoryGb": 0,
  "minReplicaMemoryGb": 0,
  "maxReplicaMemoryGb": 0,
  "numReplicas": 0,
  "idleScaling": "boolean",
  "idleTimeoutMinutes": 0,
  "ipAccessList": "Array",
  "createdAt": "date-time",
  "encryptionKey": "string",
  "encryptionAssumedRoleIdentifier": "string",
  "iamRole": "string",
  "privateEndpointIds": "Array",
  "dataWarehouseId": "string",
  "isPrimary": "string"
}

创建新服务

在组织中创建新服务，并返回当前服务状态和访问服务的密码。服务将异步启动。

方法	路径
POST	/v1/organizations/{organizationId}/services

请求

路径参数

名称	类型	描述
organizationId	uuid	将拥有服务的组织的 ID。

主体参数

名称	类型	描述
name	string	服务的名称。包含空格的字母数字字符串，最多 50 个字符。
provider	string	云提供商
region	string	服务区域。
tier	string	服务的层级：“development”、“production”、“dedicated_high_mem”、“dedicated_high_cpu”、“dedicated_standard”、“dedicated_standard_n2d_standard_4”、“dedicated_standard_n2d_standard_8”、“dedicated_standard_n2d_standard_32”、“dedicated_standard_n2d_standard_128”。生产服务进行扩展，开发服务大小固定。Azure 服务不支持开发层级
ipAccessList	array	允许访问服务的 IP 地址列表
minTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最小内存（以 GB 为单位）。仅适用于“production”服务。必须是 12 的倍数，且大于或等于 24。
maxTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最大内存（以 GB 为单位）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数，且小于或等于 360；对于付费服务，必须小于或等于 720。
minReplicaMemoryGb	number	自动扩展期间每个副本的最小总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且大于或等于 8。
maxReplicaMemoryGb	number	自动扩展期间每个副本的最大总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且对于非付费服务，必须小于或等于 120；对于付费服务，必须小于或等于 240。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。
backupId	string	可选的备份 ID，用作新服务的初始状态。使用时，新实例的区域和层级必须与原始实例的值相同。
encryptionKey	string	可选的客户提供的磁盘加密密钥
encryptionAssumedRoleIdentifier	string	用于磁盘加密的可选角色
privateEndpointIds	array	私有端点列表
privatePreviewTermsChecked	boolean	接受私有预览条款和条件。在创建组织中的第一个服务时，仅在私有预览情况下需要此参数。

响应

响应模式

名称	类型	描述
service
password	string	新创建服务的密码。

示例响应

{
  "password": "string"
}

获取服务详细信息

返回属于该组织的服务。

方法	路径
GET	/v1/organizations/{organizationId}/services/{serviceId}

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	所请求服务的 ID。

响应

响应模式

名称	类型	描述
id	uuid	唯一的服务 ID。
name	string	服务的名称。包含空格的字母数字字符串，最多 50 个字符。
provider	string	云提供商
region	string	服务区域。
state	string	服务的当前状态。
endpoints	array	所有服务端点的列表。
tier	string	服务的层级：“development”、“production”、“dedicated_high_mem”、“dedicated_high_cpu”、“dedicated_standard”、“dedicated_standard_n2d_standard_4”、“dedicated_standard_n2d_standard_8”、“dedicated_standard_n2d_standard_32”、“dedicated_standard_n2d_standard_128”。生产服务进行扩展，开发服务大小固定。Azure 服务不支持开发层级
minTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最小内存（以 GB 为单位）。仅适用于“production”服务。必须是 12 的倍数，且大于或等于 24。
maxTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最大内存（以 GB 为单位）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数，且小于或等于 360；对于付费服务，必须小于或等于 720。
minReplicaMemoryGb	number	自动扩展期间每个副本的最小总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且大于或等于 8。
maxReplicaMemoryGb	number	自动扩展期间每个副本的最大总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且对于非付费服务，必须小于或等于 120；对于付费服务，必须小于或等于 240。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。
ipAccessList	array	允许访问服务的 IP 地址列表
createdAt	date-time	服务创建时间戳。ISO-8601 格式。
encryptionKey	string	可选的客户提供的磁盘加密密钥
encryptionAssumedRoleIdentifier	string	用于磁盘加密的可选角色
iamRole	string	用于访问 s3 中对象的 IAM 角色
privateEndpointIds	array	私有端点列表
dataWarehouseId	string	包含此服务的数据库仓库
isPrimary	string	如果此服务是数据库仓库中的主要服务，则为 true

示例响应

{
  "id": "uuid",
  "name": "string",
  "provider": "string",
  "region": "string",
  "state": "string",
  "endpoints": "Array",
  "tier": "string",
  "minTotalMemoryGb": 0,
  "maxTotalMemoryGb": 0,
  "minReplicaMemoryGb": 0,
  "maxReplicaMemoryGb": 0,
  "numReplicas": 0,
  "idleScaling": "boolean",
  "idleTimeoutMinutes": 0,
  "ipAccessList": "Array",
  "createdAt": "date-time",
  "encryptionKey": "string",
  "encryptionAssumedRoleIdentifier": "string",
  "iamRole": "string",
  "privateEndpointIds": "Array",
  "dataWarehouseId": "string",
  "isPrimary": "string"
}

更新服务基本详细信息

更新服务基本详细信息，例如服务名称或 IP 访问列表。

方法	路径
PATCH	/v1/organizations/{organizationId}/services/{serviceId}

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	要更新的服务的 ID。

主体参数

名称	类型	描述
name	string	服务的名称。包含空格的字母数字字符串，最多 50 个字符。
ipAccessList
privateEndpointIds

响应

响应模式

名称	类型	描述
id	uuid	唯一的服务 ID。
name	string	服务的名称。包含空格的字母数字字符串，最多 50 个字符。
provider	string	云提供商
region	string	服务区域。
state	string	服务的当前状态。
endpoints	array	所有服务端点的列表。
tier	string	服务的层级：“development”、“production”、“dedicated_high_mem”、“dedicated_high_cpu”、“dedicated_standard”、“dedicated_standard_n2d_standard_4”、“dedicated_standard_n2d_standard_8”、“dedicated_standard_n2d_standard_32”、“dedicated_standard_n2d_standard_128”。生产服务进行扩展，开发服务大小固定。Azure 服务不支持开发层级
minTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最小内存（以 GB 为单位）。仅适用于“production”服务。必须是 12 的倍数，且大于或等于 24。
maxTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最大内存（以 GB 为单位）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数，且小于或等于 360；对于付费服务，必须小于或等于 720。
minReplicaMemoryGb	number	自动扩展期间每个副本的最小总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且大于或等于 8。
maxReplicaMemoryGb	number	自动扩展期间每个副本的最大总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且对于非付费服务，必须小于或等于 120；对于付费服务，必须小于或等于 240。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。
ipAccessList	array	允许访问服务的 IP 地址列表
createdAt	date-time	服务创建时间戳。ISO-8601 格式。
encryptionKey	string	可选的客户提供的磁盘加密密钥
encryptionAssumedRoleIdentifier	string	用于磁盘加密的可选角色
iamRole	string	用于访问 s3 中对象的 IAM 角色
privateEndpointIds	array	私有端点列表
dataWarehouseId	string	包含此服务的数据库仓库
isPrimary	string	如果此服务是数据库仓库中的主要服务，则为 true

示例响应

{
  "id": "uuid",
  "name": "string",
  "provider": "string",
  "region": "string",
  "state": "string",
  "endpoints": "Array",
  "tier": "string",
  "minTotalMemoryGb": 0,
  "maxTotalMemoryGb": 0,
  "minReplicaMemoryGb": 0,
  "maxReplicaMemoryGb": 0,
  "numReplicas": 0,
  "idleScaling": "boolean",
  "idleTimeoutMinutes": 0,
  "ipAccessList": "Array",
  "createdAt": "date-time",
  "encryptionKey": "string",
  "encryptionAssumedRoleIdentifier": "string",
  "iamRole": "string",
  "privateEndpointIds": "Array",
  "dataWarehouseId": "string",
  "isPrimary": "string"
}

删除服务

删除服务。服务必须处于停止状态，并且在调用此方法后将异步删除。

方法	路径
DELETE	/v1/organizations/{organizationId}/services/{serviceId}

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	要删除的服务的 ID。

获取私有端点配置

设置私有端点所需的 정보

方法	路径
GET	/v1/organizations/{organizationId}/services/{serviceId}/privateEndpointConfig

请求

路径参数

名称	类型	描述
organizationId	uuid	所请求组织的 ID。
serviceId	uuid	所请求服务的 ID。

响应

响应模式

名称	类型	描述
endpointServiceId	string	您在 VPC 中使用 AWS（服务名称）、GCP（目标服务）或 AZURE（私有链接服务）资源创建的接口端点的唯一标识符
privateDnsHostname	string	您创建的 VPC 的私有 DNS 主机名

示例响应

{
  "endpointServiceId": "string",
  "privateDnsHostname": "string"
}

更新服务状态

启动或停止服务

方法	路径
PATCH	/v1/organizations/{organizationId}/services/{serviceId}/state

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	要更新状态的服务的 ID。

主体参数

名称	类型	描述
command	string	更改状态的命令：'start'、'stop'。

响应

响应模式

名称	类型	描述
id	uuid	唯一的服务 ID。
name	string	服务的名称。包含空格的字母数字字符串，最多 50 个字符。
provider	string	云提供商
region	string	服务区域。
state	string	服务的当前状态。
endpoints	array	所有服务端点的列表。
tier	string	服务的层级：“development”、“production”、“dedicated_high_mem”、“dedicated_high_cpu”、“dedicated_standard”、“dedicated_standard_n2d_standard_4”、“dedicated_standard_n2d_standard_8”、“dedicated_standard_n2d_standard_32”、“dedicated_standard_n2d_standard_128”。生产服务进行扩展，开发服务大小固定。Azure 服务不支持开发层级
minTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最小内存（以 GB 为单位）。仅适用于“production”服务。必须是 12 的倍数，且大于或等于 24。
maxTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最大内存（以 GB 为单位）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数，且小于或等于 360；对于付费服务，必须小于或等于 720。
minReplicaMemoryGb	number	自动扩展期间每个副本的最小总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且大于或等于 8。
maxReplicaMemoryGb	number	自动扩展期间每个副本的最大总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且对于非付费服务，必须小于或等于 120；对于付费服务，必须小于或等于 240。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。
ipAccessList	array	允许访问服务的 IP 地址列表
createdAt	date-time	服务创建时间戳。ISO-8601 格式。
encryptionKey	string	可选的客户提供的磁盘加密密钥
encryptionAssumedRoleIdentifier	string	用于磁盘加密的可选角色
iamRole	string	用于访问 s3 中对象的 IAM 角色
privateEndpointIds	array	私有端点列表
dataWarehouseId	string	包含此服务的数据库仓库
isPrimary	string	如果此服务是数据库仓库中的主要服务，则为 true

示例响应

{
  "id": "uuid",
  "name": "string",
  "provider": "string",
  "region": "string",
  "state": "string",
  "endpoints": "Array",
  "tier": "string",
  "minTotalMemoryGb": 0,
  "maxTotalMemoryGb": 0,
  "minReplicaMemoryGb": 0,
  "maxReplicaMemoryGb": 0,
  "numReplicas": 0,
  "idleScaling": "boolean",
  "idleTimeoutMinutes": 0,
  "ipAccessList": "Array",
  "createdAt": "date-time",
  "encryptionKey": "string",
  "encryptionAssumedRoleIdentifier": "string",
  "iamRole": "string",
  "privateEndpointIds": "Array",
  "dataWarehouseId": "string",
  "isPrimary": "string"
}

更新服务自动扩展设置

更新服务的最小和最大总内存限制以及空闲模式扩展行为。内存设置仅适用于“生产”服务，并且必须是 12 的倍数，从 24GB 开始。请联系支持以启用 numReplicas 的调整。

方法	路径
PATCH	/v1/organizations/{organizationId}/services/{serviceId}/scaling

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	要更新扩展参数的服务的 ID。

主体参数

名称	类型	描述
minTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最小内存（以 GB 为单位）。仅适用于“production”服务。必须是 12 的倍数，且大于或等于 24。
maxTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最大内存（以 GB 为单位）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数，且小于或等于 360；对于付费服务，必须小于或等于 720。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。

响应

响应模式

名称	类型	描述
id	uuid	唯一的服务 ID。
name	string	服务的名称。包含空格的字母数字字符串，最多 50 个字符。
provider	string	云提供商
region	string	服务区域。
state	string	服务的当前状态。
endpoints	array	所有服务端点的列表。
tier	string	服务的层级：“development”、“production”、“dedicated_high_mem”、“dedicated_high_cpu”、“dedicated_standard”、“dedicated_standard_n2d_standard_4”、“dedicated_standard_n2d_standard_8”、“dedicated_standard_n2d_standard_32”、“dedicated_standard_n2d_standard_128”。生产服务进行扩展，开发服务大小固定。Azure 服务不支持开发层级
minTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最小内存（以 GB 为单位）。仅适用于“production”服务。必须是 12 的倍数，且大于或等于 24。
maxTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最大内存（以 GB 为单位）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数，且小于或等于 360；对于付费服务，必须小于或等于 720。
minReplicaMemoryGb	number	自动扩展期间每个副本的最小总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且大于或等于 8。
maxReplicaMemoryGb	number	自动扩展期间每个副本的最大总内存（以 GB 为单位）。仅适用于“production”服务。必须是 4 的倍数，且对于非付费服务，必须小于或等于 120；对于付费服务，必须小于或等于 240。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。
ipAccessList	array	允许访问服务的 IP 地址列表
createdAt	date-time	服务创建时间戳。ISO-8601 格式。
encryptionKey	string	可选的客户提供的磁盘加密密钥
encryptionAssumedRoleIdentifier	string	用于磁盘加密的可选角色
iamRole	string	用于访问 s3 中对象的 IAM 角色
privateEndpointIds	array	私有端点列表
dataWarehouseId	string	包含此服务的数据库仓库
isPrimary	string	如果此服务是数据库仓库中的主要服务，则为 true

示例响应

{
  "id": "uuid",
  "name": "string",
  "provider": "string",
  "region": "string",
  "state": "string",
  "endpoints": "Array",
  "tier": "string",
  "minTotalMemoryGb": 0,
  "maxTotalMemoryGb": 0,
  "minReplicaMemoryGb": 0,
  "maxReplicaMemoryGb": 0,
  "numReplicas": 0,
  "idleScaling": "boolean",
  "idleTimeoutMinutes": 0,
  "ipAccessList": "Array",
  "createdAt": "date-time",
  "encryptionKey": "string",
  "encryptionAssumedRoleIdentifier": "string",
  "iamRole": "string",
  "privateEndpointIds": "Array",
  "dataWarehouseId": "string",
  "isPrimary": "string"
}

更新服务自动扩展设置

更新服务的每个副本的最小和最大内存限制以及空闲模式扩展行为。内存设置仅适用于“生产”服务，并且必须是 4 的倍数，从 8GB 开始。请联系支持以启用 numReplicas 的调整。

方法	路径
PATCH	/v1/organizations/{organizationId}/services/{serviceId}/replicaScaling

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	要更新扩展参数的服务的 ID。

主体参数

名称	类型	描述
minReplicaMemoryGb	number	单个副本的自动扩展最小内存（以 Gb 为单位）。仅适用于“生产”服务。必须是 4 的倍数，并且大于或等于 8。
maxReplicaMemoryGb	number	单个副本的自动扩展最大内存（以 Gb 为单位）。仅适用于“生产”服务。必须是 4 的倍数，对于非付费服务，小于或等于 120，对于付费服务，小于或等于 240。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。

响应

响应模式

名称	类型	描述
id	uuid	唯一的服务 ID。
name	string	服务的名称。包含空格的字母数字字符串，最多 50 个字符。
provider	string	云提供商
region	string	服务区域。
state	string	服务的当前状态。
endpoints	array	所有服务端点的列表。
tier	string	服务的层级：“development”、“production”、“dedicated_high_mem”、“dedicated_high_cpu”、“dedicated_standard”、“dedicated_standard_n2d_standard_4”、“dedicated_standard_n2d_standard_8”、“dedicated_standard_n2d_standard_32”、“dedicated_standard_n2d_standard_128”。生产服务进行扩展，开发服务大小固定。Azure 服务不支持开发层级
minTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最小内存（以 GB 为单位）。仅适用于“production”服务。必须是 12 的倍数，且大于或等于 24。
maxTotalMemoryGb	number	已弃用 - 对于具有非默认副本数量的服务不准确。自动扩展期间三个工作程序的最大内存（以 GB 为单位）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数，且小于或等于 360；对于付费服务，必须小于或等于 720。
minReplicaMemoryGb	number	单个副本的自动扩展最小内存（以 Gb 为单位）。仅适用于“生产”服务。必须是 4 的倍数，并且大于或等于 8。
maxReplicaMemoryGb	number	单个副本的自动扩展最大内存（以 Gb 为单位）。仅适用于“生产”服务。必须是 4 的倍数，对于非付费服务，小于或等于 120，对于付费服务，小于或等于 240。
numReplicas	number	服务的副本数量。必须介于 3 到 20 之间。联系支持团队以启用此功能。
idleScaling	boolean	设置为 true 时，允许服务在空闲时缩减到零。默认情况下为 true。
idleTimeoutMinutes	number	设置最小空闲超时（以分钟为单位）。必须大于等于 5 分钟。
ipAccessList	array	允许访问服务的 IP 地址列表
createdAt	date-time	服务创建时间戳。ISO-8601 格式。
encryptionKey	string	可选的客户提供的磁盘加密密钥
encryptionAssumedRoleIdentifier	string	用于磁盘加密的可选角色
iamRole	string	用于访问 s3 中对象的 IAM 角色
privateEndpointIds	array	私有端点列表
dataWarehouseId	string	包含此服务的数据库仓库
isPrimary	string	如果此服务是数据库仓库中的主要服务，则为 true

示例响应

{
  "id": "uuid",
  "name": "string",
  "provider": "string",
  "region": "string",
  "state": "string",
  "endpoints": "Array",
  "tier": "string",
  "minTotalMemoryGb": 0,
  "maxTotalMemoryGb": 0,
  "minReplicaMemoryGb": 0,
  "maxReplicaMemoryGb": 0,
  "numReplicas": 0,
  "idleScaling": "boolean",
  "idleTimeoutMinutes": 0,
  "ipAccessList": "Array",
  "createdAt": "date-time",
  "encryptionKey": "string",
  "encryptionAssumedRoleIdentifier": "string",
  "iamRole": "string",
  "privateEndpointIds": "Array",
  "dataWarehouseId": "string",
  "isPrimary": "string"
}

更新服务密码

为服务设置新密码

方法	路径
PATCH	/v1/organizations/{organizationId}/services/{serviceId}/password

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	要更新密码的服务的 ID。

主体参数

名称	类型	描述
newPasswordHash	string	可选密码哈希。用于避免通过网络传输密码。如果没有提供，则会生成一个新密码并在响应中提供。否则，将使用此哈希。算法：echo -n "yourpassword"
newDoubleSha1Hash	string	用于 MySQL 协议的可选双 SHA1 密码哈希。如果未提供 newPasswordHash，则此键将被忽略，并将使用生成的密码。算法：echo -n "yourpassword"

响应

响应模式

名称	类型	描述
password	string	新的服务密码。仅当请求中没有“newPasswordHash”时才会提供

示例响应

{
  "password": "string"
}

获取 Prometheus 指标

返回服务的 Prometheus 指标。

方法	路径
GET	/v1/organizations/{organizationId}/services/{serviceId}/prometheus

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	所请求服务的 ID。

服务备份列表

返回服务的备份列表。最新的备份在列表中排在最前面。

方法	路径
GET	/v1/organizations/{organizationId}/services/{serviceId}/backups

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有备份的组织的 ID。
serviceId	uuid	创建备份的服务的 ID。

响应

响应模式

名称	类型	描述
id	uuid	唯一的备份 ID。
status	string	备份的状态：'done'、'error'、'in_progress'。
serviceId	string	名称
startedAt	date-time	备份开始时间戳。ISO-8601。
finishedAt	date-time	备份完成时间戳。ISO-8601。仅适用于已完成的备份
sizeInBytes	number	备份的大小（以字节为单位）。
durationInSeconds	number	执行备份所需的时间（以秒为单位）。如果状态仍然是“in_progress”，则这是从备份开始到现在的秒数。
type	string	备份类型（“full”或“incremental”）。

示例响应

{
  "id": "uuid",
  "status": "string",
  "serviceId": "string",
  "startedAt": "date-time",
  "finishedAt": "date-time",
  "sizeInBytes": 0,
  "durationInSeconds": 0,
  "type": "string"
}

获取备份详细信息

返回单个备份信息。

方法	路径
GET	/v1/organizations/{organizationId}/services/{serviceId}/backups/{backupId}

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有备份的组织的 ID。
serviceId	uuid	创建备份的服务的 ID。
backupId	uuid	请求的备份的 ID。

响应

响应模式

名称	类型	描述
id	uuid	唯一的备份 ID。
status	string	备份的状态：'done'、'error'、'in_progress'。
serviceId	string	名称
startedAt	date-time	备份开始时间戳。ISO-8601。
finishedAt	date-time	备份完成时间戳。ISO-8601。仅适用于已完成的备份
sizeInBytes	number	备份的大小（以字节为单位）。
durationInSeconds	number	执行备份所需的时间（以秒为单位）。如果状态仍然是“in_progress”，则这是从备份开始到现在的秒数。
type	string	备份类型（“full”或“incremental”）。

示例响应

{
  "id": "uuid",
  "status": "string",
  "serviceId": "string",
  "startedAt": "date-time",
  "finishedAt": "date-time",
  "sizeInBytes": 0,
  "durationInSeconds": 0,
  "type": "string"
}

获取服务备份配置

返回服务备份配置。

方法	路径
GET	/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	服务的 ID。

响应

响应模式

名称	类型	描述
backupPeriodInHours	number	每次备份之间的时间间隔（以小时为单位）。
backupRetentionPeriodInHours	number	备份可用的最短持续时间（以小时为单位）。
backupStartTime	string	执行备份的时间（以 HH:MM 格式表示，在 UTC 时区中评估）。定义后，备份周期重置为每 24 小时。

示例响应

{
  "backupPeriodInHours": 0,
  "backupRetentionPeriodInHours": 0,
  "backupStartTime": "string"
}

更新服务备份配置

更新服务备份配置。需要 ADMIN 身份验证密钥角色。使用 null 值设置属性将重置属性为默认值。

方法	路径
PATCH	/v1/organizations/{organizationId}/services/{serviceId}/backupConfiguration

请求

路径参数

名称	类型	描述
organizationId	uuid	拥有该服务的组织的 ID。
serviceId	uuid	服务的 ID。

主体参数

名称	类型	描述
backupPeriodInHours	number	每次备份之间的时间间隔（以小时为单位）。
backupRetentionPeriodInHours	number	备份可用的最短持续时间（以小时为单位）。
backupStartTime	string	执行备份的时间（以 HH:MM 格式表示，在 UTC 时区中评估）。定义后，备份周期重置为每 24 小时。

响应

响应模式

名称	类型	描述
backupPeriodInHours	number	每次备份之间的时间间隔（以小时为单位）。
backupRetentionPeriodInHours	number	备份可用的最短持续时间（以小时为单位）。
backupStartTime	string	执行备份的时间（以 HH:MM 格式表示，在 UTC 时区中评估）。定义后，备份周期重置为每 24 小时。

示例响应

{
  "backupPeriodInHours": 0,
  "backupRetentionPeriodInHours": 0,
  "backupStartTime": "string"
}

组织服务列表​

请求​

路径参数​

响应​

响应模式​

示例响应​

创建新服务​

请求​

路径参数​

主体参数​

响应​

响应模式​

示例响应​

获取服务详细信息​

请求​

路径参数​

响应​

响应模式​

示例响应​

更新服务基本详细信息​

请求​

路径参数​

主体参数​

响应​

响应模式​

示例响应​

删除服务​

请求​

路径参数​

获取私有端点配置​

请求​

路径参数​

响应​

响应模式​

示例响应​

更新服务状态​

请求​

路径参数​

主体参数​

响应​

响应模式​

示例响应​

更新服务自动扩展设置​

请求​

路径参数​

主体参数​

响应​

响应模式​

示例响应​

更新服务自动扩展设置​

请求​

路径参数​

主体参数​

响应​

响应模式​

示例响应​

更新服务密码​

请求​

路径参数​

主体参数​

响应​

响应模式​

示例响应​

获取 Prometheus 指标​

请求​

路径参数​

服务备份列表​

请求​

路径参数​

响应​

响应模式​

示例响应​

获取备份详细信息​

请求​

路径参数​

响应​

响应模式​

示例响应​

获取服务备份配置​

请求​

组织服务列表

请求

路径参数

响应

响应模式

示例响应

创建新服务

请求

路径参数

主体参数

响应

响应模式

示例响应

获取服务详细信息

请求

路径参数

响应

响应模式

示例响应

更新服务基本详细信息

请求

路径参数

主体参数

响应

响应模式

示例响应

删除服务

请求

路径参数

获取私有端点配置

请求

路径参数

响应

响应模式

示例响应

更新服务状态

请求

路径参数

主体参数

响应

响应模式

示例响应

更新服务自动扩展设置

请求

路径参数

主体参数

响应

响应模式

示例响应

更新服务自动扩展设置

请求

路径参数

主体参数

响应

响应模式

示例响应

更新服务密码

请求

路径参数

主体参数

响应

响应模式

示例响应

获取 Prometheus 指标

请求

路径参数

服务备份列表

请求

路径参数

响应

响应模式

示例响应

获取备份详细信息

请求

路径参数

响应

响应模式

示例响应

获取服务备份配置

请求