API 文档由 Redocly 提供

ClickHouse Cloud 的 OpenAPI 规范 (1.0)

下载 OpenAPI 规范:下载

ClickHouse 支持: [email protected] URL: https://clickhouse.ac.cn/docs/en/cloud/manage/openapi?referrer=openapi-150926

获取可用组织列表

返回请求中与 API 密钥关联的单个组织列表。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": [
    ]
}

获取组织详情

返回单个组织的详细信息。为了获取详细信息，认证密钥必须属于该组织。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新组织详情

更新组织字段。需要 ADMIN 认证密钥角色。

路径参数
organizationId
必需
string <uuid>

要更新的组织的 ID。

请求体架构: application/json
name
string

组织名称。

object (OrganizationPrivateEndpointsPatch)

响应

请求示例

内容类型
application/json
{
  • "name": "string",
  • "privateEndpoints": {
    }
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取组织指标

返回组织中所有服务的 Prometheus 指标。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

查询参数
filtered_metrics
string <boolean>

返回 Prometheus 指标的过滤列表。

响应

响应示例

内容类型
application/json
{
  • "status": 400,
  • "error": "string"
}

组织服务列表

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

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": [
    ]
}

创建新服务

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

路径参数
organizationId
必需
string <uuid>

将拥有该服务的组织的 ID。

请求体架构: application/json
name
string

服务名称。最多 50 个字符的字母数字字符串，可以包含空格。

provider
string
枚举: "aws" "gcp" "azure"

云提供商

region
string
枚举: "ap-south-1" "ap-southeast-1" "eu-central-1" "eu-west-1" "eu-west-2" "us-east-1" "us-east-2" "us-west-2" "ap-southeast-2" "ap-northeast-1" "us-east1" "us-central1" "europe-west4" "asia-southeast1" "eastus" "eastus2" "westus3" "germanywestcentral"

服务区域。

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" "dedicated_standard_n2d_standard_32_16SSD" "dedicated_standard_n2d_standard_64_24SSD"

服务层级: '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'，'dedicated_standard_n2d_standard_32_16SSD'，'dedicated_standard_n2d_standard_64_24SSD'。生产服务可伸缩，开发服务大小固定。Azure 服务不支持开发层级

对象数组 objects (IpAccessListEntry)

允许访问服务的 IP 地址列表

minTotalMemoryGb
number 12 的倍数 [ 24 .. 708 ]
已弃用

已弃用 - 对于具有非默认副本数量的服务，此值不准确。自动伸缩期间三个工作节点的最小内存（Gb）。仅适用于“production”服务。必须是 12 的倍数且大于或等于 24。

maxTotalMemoryGb
number 12 的倍数 [ 24 .. 708 ]
已弃用

已弃用 - 对于具有非默认副本数量的服务，此值不准确。自动伸缩期间三个工作节点的最大内存（Gb）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。

minReplicaMemoryGb
number 4 的倍数 [ 8 .. 236 ]

自动伸缩期间每个副本的最小总内存（Gb）。必须是 4 的倍数且大于或等于 8。

maxReplicaMemoryGb
number 4 的倍数 [ 8 .. 236 ]

自动伸缩期间每个副本的最大总内存（Gb）。必须是 4 的倍数且小于或等于 120*（对于非付费服务）或 236*（对于付费服务）。* - 最大副本大小取决于您所选区域中云提供商的硬件可用性。

numReplicas
number [ 1 .. 20 ]

服务的副本数。必须介于 1 到 20 之间。请联系支持部门以启用此功能。

idleScaling
boolean

设置为 true 时，允许服务在空闲时缩减到零。默认为 true。

idleTimeoutMinutes
number

设置最小空闲超时时间（分钟）。必须 >= 5 分钟。

isReadonly
boolean

如果此服务是只读的，则为 True。仅当提供了 dataWarehouseId 时，它才能是只读的。

dataWarehouseId
string

包含此服务的数据仓库

backupId
string <uuid>

可选的备份 ID，用作新服务的初始状态。使用时，新实例的区域和层级必须与原始实例的值相同。

encryptionKey
string

可选的客户提供的磁盘加密密钥

encryptionAssumedRoleIdentifier
string

用于磁盘加密的可选角色

privateEndpointIds
字符串数组 strings

私有终端列表

privatePreviewTermsChecked
boolean

接受私有预览条款和条件。仅在私有预览的情况下，在组织中创建第一个服务时才需要

releaseChannel
string
枚举: "default" "fast"

如果您想尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但出现错误的风险也更高。此功能仅适用于生产服务。

byocId
string

这是在为自带云 (BYOC) 设置区域后返回的 ID。当指定 byocId 参数时，minReplicaMemoryGb 和 maxReplicaGb 参数也是必需的，其值包含在以下大小中：28、60、124、188、252、380。

响应

请求示例

内容类型
application/json
{
  • "name": "string",
  • "provider": "aws",
  • "region": "ap-south-1",
  • "tier": "development",
  • "ipAccessList": [
    ],
  • "minTotalMemoryGb": 48,
  • "maxTotalMemoryGb": 360,
  • "minReplicaMemoryGb": 16,
  • "maxReplicaMemoryGb": 120,
  • "numReplicas": 3,
  • "idleScaling": true,
  • "idleTimeoutMinutes": 0,
  • "isReadonly": true,
  • "dataWarehouseId": "string",
  • "backupId": "eb7cea43-10b2-42dd-8819-ab9aed37565f",
  • "encryptionKey": "string",
  • "encryptionAssumedRoleIdentifier": "string",
  • "privateEndpointIds": [
    ],
  • "privatePreviewTermsChecked": true,
  • "releaseChannel": "default",
  • "byocId": "string"
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取服务详情

返回属于该组织的服务

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

请求的服务的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新服务基本详情

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

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

要更新的服务的 ID。

请求体架构: application/json
name
string

服务名称。最多 50 个字符的字母数字字符串，可以包含空格。

object (IpAccessListPatch)
object (InstancePrivateEndpointsPatch)
releaseChannel
string
枚举: "default" "fast"

如果您想尽快获得新的 ClickHouse 版本，请选择 fast。您将更快地获得新功能，但出现错误的风险也更高。此功能仅适用于生产服务。

响应

请求示例

内容类型
application/json
{
  • "name": "string",
  • "ipAccessList": {
    },
  • "privateEndpointIds": {
    },
  • "releaseChannel": "default"
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

删除服务

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

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

要删除的服务的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

获取私有终端配置

设置私有终端所需的信息

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

serviceId
必需
string <uuid>

请求的服务的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取给定实例的服务查询终端

这是一项实验性功能。请联系支持部门以启用它。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

serviceId
必需
string <uuid>

请求的服务的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

删除给定实例的服务查询终端

这是一项实验性功能。请联系支持部门以启用它。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

serviceId
必需
string <uuid>

请求的服务的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

更新或插入给定实例的服务查询终端

这是一项实验性功能。请联系支持部门以启用它。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

serviceId
必需
string <uuid>

请求的服务的 ID。

请求体架构: application/json
roles
字符串数组 strings
项目枚举: "sql_console_read_only" "sql_console_admin"

角色

openApiKeys
字符串数组 strings

服务查询终端的版本

allowedOrigins
string

允许的来源，以逗号分隔的域名列表

响应

请求示例

内容类型
application/json
{
  • "roles": [
    ],
  • "openApiKeys": [
    ],
  • "allowedOrigins": "string"
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新服务状态

启动或停止服务

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

要更新状态的服务的 ID。

请求体架构: application/json
command
string
枚举: "start" "stop"

更改状态的命令: 'start'，'stop'。

响应

请求示例

内容类型
application/json
{
  • "command": "start"
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新服务自动伸缩设置 已弃用

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

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

要更新伸缩参数的服务的 ID。

请求体架构: application/json
minTotalMemoryGb
number 12 的倍数 [ 24 .. 708 ]
已弃用

已弃用 - 对于具有非默认副本数量的服务，此值不准确。自动伸缩期间三个工作节点的最小内存（Gb）。仅适用于“production”服务。必须是 12 的倍数且大于或等于 24。

maxTotalMemoryGb
number 12 的倍数 [ 24 .. 708 ]
已弃用

已弃用 - 对于具有非默认副本数量的服务，此值不准确。自动伸缩期间三个工作节点的最大内存（Gb）。仅适用于“production”服务。对于非付费服务，必须是 12 的倍数且小于或等于 360；对于付费服务，则为 708。

numReplicas
number [ 1 .. 20 ]

服务的副本数。必须介于 1 到 20 之间。请联系支持部门以启用此功能。

idleScaling
boolean

设置为 true 时，允许服务在空闲时缩减到零。默认为 true。

idleTimeoutMinutes
number

设置最小空闲超时时间（分钟）。必须 >= 5 分钟。

响应

请求示例

内容类型
application/json
{
  • "minTotalMemoryGb": 48,
  • "maxTotalMemoryGb": 360,
  • "numReplicas": 3,
  • "idleScaling": true,
  • "idleTimeoutMinutes": 0
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新服务自动伸缩设置

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

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

要更新伸缩参数的服务的 ID。

请求体架构: application/json
minReplicaMemoryGb
number 4 的倍数 [ 8 .. 236 ]

单个副本的最小自动伸缩内存（Gb）。仅适用于“production”服务。必须是 4 的倍数且大于或等于 8。

maxReplicaMemoryGb
number 4 的倍数 [ 8 .. 236 ]

单个副本的最大自动伸缩内存（Gb）。仅适用于“production”服务。必须是 4 的倍数且小于或等于 120（对于非付费服务）或 236（对于付费服务）。

numReplicas
number [ 1 .. 20 ]

服务的副本数。必须介于 1 到 20 之间。请联系支持部门以启用此功能。

idleScaling
boolean

设置为 true 时，允许服务在空闲时缩减到零。默认为 true。

idleTimeoutMinutes
number

设置最小空闲超时时间（分钟）。必须 >= 5 分钟。

响应

请求示例

内容类型
application/json
{
  • "minReplicaMemoryGb": 16,
  • "maxReplicaMemoryGb": 120,
  • "numReplicas": 3,
  • "idleScaling": true,
  • "idleTimeoutMinutes": 0
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新服务密码

为服务设置新密码

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

要更新密码的服务的 ID。

请求体架构: application/json
newPasswordHash
string

可选的密码哈希值。用于避免通过网络传输密码。如果未提供，则会生成一个新密码并在响应中提供。否则，将使用此哈希值。算法：echo -n "yourpassword" | sha256sum | tr -d '-' | xxd -r -p | base64

newDoubleSha1Hash
string

MySQL 协议的可选双重 SHA1 密码哈希值。如果未提供 newPasswordHash，则将忽略此键，并将使用生成的密码。算法：echo -n "yourpassword" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-'

响应

请求示例

内容类型
application/json
{
  • "newPasswordHash": "string",
  • "newDoubleSha1Hash": "string"
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取 Prometheus 指标

返回服务的 Prometheus 指标。

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

请求的服务的 ID。

查询参数
filtered_metrics
string <boolean>

返回 Prometheus 指标的过滤列表。

响应

响应示例

内容类型
application/json
{
  • "status": 400,
  • "error": "string"
}

服务备份列表

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

路径参数
organizationId
必需
string <uuid>

拥有备份的组织的 ID。

serviceId
必需
string <uuid>

创建备份的服务 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": [
    ]
}

获取备份详情

返回单个备份信息。

路径参数
organizationId
必需
string <uuid>

拥有备份的组织的 ID。

serviceId
必需
string <uuid>

创建备份的服务 ID。

backupId
必需
string <uuid>

请求的备份 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取服务备份配置

返回服务备份配置。

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

服务的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新服务备份配置

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

路径参数
organizationId
必需
string <uuid>

拥有该服务的组织的 ID。

serviceId
必需
string <uuid>

服务的 ID。

请求体架构: application/json
backupPeriodInHours
number

每次备份之间的小时间隔。

backupRetentionPeriodInHours
number

备份可用的最短持续时间（小时）。

backupStartTime
string

执行备份的时间，格式为 HH:MM（以 UTC 时区评估）。定义后，备份周期将重置为每 24 小时一次。

响应

请求示例

内容类型
application/json
{
  • "backupPeriodInHours": 0,
  • "backupRetentionPeriodInHours": 0,
  • "backupStartTime": "string"
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取所有密钥列表

返回组织中所有密钥的列表。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": [
    ]
}

创建密钥

创建新的 API 密钥。

路径参数
organizationId
必需
string <uuid>

将拥有密钥的组织的 ID。

请求体架构: application/json
name
string

密钥的名称。

expireAt
string <date-time>

密钥过期的的时间戳。如果不存在或为空，则密钥永不过期。ISO-8601。

state
string
Enum: "enabled" "disabled"

密钥的初始状态：“enabled”（启用）、“disabled”（禁用）。如果未提供，则新密钥将为“enabled”（启用）。

object (ApiKeyHashData)
roles
字符串数组 strings
Items Enum: "admin" "developer" "org_member" "billing"

分配给密钥的角色列表。至少包含 1 个元素。

响应

请求示例

内容类型
application/json
{
  • "name": "string",
  • "expireAt": "2019-08-24T14:15:22Z",
  • "state": "enabled",
  • "hashData": {
    },
  • "roles": [
    ]
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取密钥详情

返回单个密钥的详细信息。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

keyId
必需
string <uuid>

请求的密钥 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新密钥

更新 API 密钥属性。

路径参数
organizationId
必需
string <uuid>

拥有密钥的组织的 ID。

keyId
必需
string <uuid>

要更新的密钥 ID。

请求体架构: application/json
name
string

密钥的名称

roles
字符串数组 strings
Items Enum: "admin" "developer" "org_member" "billing"

分配给密钥的角色列表。至少包含 1 个元素。

expireAt
string <date-time>

密钥过期的的时间戳。如果不存在或为空，则密钥永不过期。ISO-8601。

state
string
Enum: "enabled" "disabled"

密钥的状态：“enabled”（启用）、“disabled”（禁用）。

响应

请求示例

内容类型
application/json
{
  • "name": "string",
  • "roles": [
    ],
  • "expireAt": "2019-08-24T14:15:22Z",
  • "state": "enabled"
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

删除密钥

删除 API 密钥。只能删除未用于身份验证活动请求的密钥。

路径参数
organizationId
必需
string <uuid>

拥有密钥的组织的 ID。

keyId
必需
string <uuid>

要删除的密钥 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

列出组织成员

返回组织中所有成员的列表。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": [
    ]
}

获取成员详情

返回单个组织成员的详细信息。

路径参数
organizationId
必需
string <uuid>

成员所属的组织的 ID。

userId
必需
string <uuid>

请求的用户 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

更新组织成员。

更新组织成员角色。

路径参数
organizationId
必需
string <uuid>

成员所属的组织的 ID。

userId
必需
string <uuid>

要修补的用户的 ID

请求体架构: application/json
role
string
Enum: "admin" "developer" "org_member" "billing"

成员在组织中的角色。

响应

请求示例

内容类型
application/json
{
  • "role": "admin"
}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

移除组织成员

从组织中移除用户

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

userId
必需
string <uuid>

请求的用户 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

列出所有邀请

返回所有组织邀请的列表。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": [
    ]
}

创建邀请

创建组织邀请。

路径参数
organizationId
必需
string <uuid>

要邀请用户加入的组织的 ID。

请求体架构: application/json
email
string <email>

被邀请用户的电子邮件。只有具有此电子邮件的用户才能使用邀请加入。电子邮件以小写形式存储。

role
string
Enum: "admin" "developer" "org_member" "billing"

成员在组织中的角色。

响应

请求示例

内容类型
application/json
{}

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取邀请详情

返回单个组织邀请的详细信息。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

invitationId
必需
string <uuid>

请求的组织的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

删除组织邀请

删除单个组织邀请。

路径参数
organizationId
必需
string <uuid>

拥有邀请的组织的 ID。

invitationId
必需
string <uuid>

请求的组织的 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

列出组织活动

返回所有组织活动的列表。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

查询参数
from_date
string <date-time>

搜索的开始日期

to_date
string <date-time>

搜索的结束日期

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": [
    ]
}

组织活动

按 ID 返回单个组织活动。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

activityId
必需
string

请求的活动 ID。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取组织使用成本

这是一项实验性功能。请联系支持部门以启用它。

返回查询时间段内（最多 31 天）组织的每日、每实体组织使用成本记录的总计和列表。请求和响应中的所有日期均基于 UTC 时区进行评估。

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

查询参数
from_date
必需
string <date-time>

报告的开始日期，例如 2024-12-19。

to_date
必需
string <date-time>

报告的结束日期（包括在内），例如 2024-12-20。此日期不能晚于 from_date 之后 30 天（最长查询期限为 31 天）。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}

获取组织内云提供商区域的私有端点配置

设置私有终端所需的信息

路径参数
organizationId
必需
string <uuid>

请求的组织的 ID。

查询参数
Cloud provider identifier
必需
string

云提供商标识符。aws、gcp 或 azure 之一。

Cloud provider region
必需
string

特定云提供商内的区域标识符。

响应

响应示例

内容类型
application/json
{
  • "status": 200,
  • "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  • "result": {
    }
}