你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Sql Resources - Sql Container Retrieve Throughput Distribution

参考

服务:: Cosmos DB Resource Provider

API 版本:: 2025-05-01-preview

检索 Azure Cosmos DB SQL 容器的吞吐量分布

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default/retrieveThroughputDistribution?api-version=2025-05-01-preview

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 数据库帐户名称。
containerName	path	True	string	Cosmos DB 容器名称。
databaseName	path	True	string	Cosmos DB 数据库名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。此名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求正文

名称	类型	说明
retrieveThroughputParameters	RetrieveThroughputParameters	用于检索当前 SQL 容器的吞吐量分布的参数。

响应

名称	类型	说明
200 OK	PhysicalPartitionThroughputInfoResult	SQL 容器操作的检索吞吐量分布已成功完成。
202 Accepted		SQL 容器操作的检索吞吐量分布将异步完成。标头 azure-AsyncOperation: string location: string
Other Status Codes	CloudError	描述操作失败的原因的错误响应。

名称

类型

说明

200 OK

PhysicalPartitionThroughputInfoResult

SQL 容器操作的检索吞吐量分布已成功完成。

202 Accepted

SQL 容器操作的检索吞吐量分布将异步完成。

标头

azure-AsyncOperation: string
location: string

Other Status Codes

CloudError

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟您的用户账户

示例

CosmosDBSqlContainerRetrieveThroughputDistribution

示例请求

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/containers/containerName/throughputSettings/default/retrieveThroughputDistribution?api-version=2025-05-01-preview

{
  "properties": {
    "resource": {
      "physicalPartitionIds": [
        {
          "id": "0"
        },
        {
          "id": "1"
        }
      ]
    }
  }
}

示例响应

状态代码:: 200

{
  "properties": {
    "resource": {
      "physicalPartitionThroughputInfo": [
        {
          "id": "0",
          "throughput": 5000,
          "targetThroughput": 5000
        },
        {
          "id": "1",
          "throughput": 5000,
          "targetThroughput": 5000
        }
      ]
    }
  }
}

状态代码:: 202

azure-AsyncOperation: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview
location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview

定义

名称	说明
CloudError	服务的错误响应。
ErrorResponse	错误响应。
ManagedServiceIdentity	资源的标识。
PhysicalPartitionId	PhysicalPartitionId 对象的数组。
PhysicalPartitionThroughputInfoResource	物理分区吞吐量信息对象的数组
PhysicalPartitionThroughputInfoResult	Azure Cosmos DB PhysicalPartitionThroughputInfoResult 对象。
Resource	物理分区吞吐量信息的属性
ResourceIdentityType	用于资源的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从服务中删除任何标识。
RetrieveThroughputParameters	用于检索当前 SQL 容器的吞吐量分布的参数。
RetrieveThroughputPropertiesResource	资源吞吐量的标准 JSON 格式
UserAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

CloudError

Object

服务的错误响应。

名称	类型	说明
error	ErrorResponse	错误响应。

ErrorResponse

Object

错误响应。

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败的原因的错误消息。

ManagedServiceIdentity

Object

资源的标识。

名称	类型	说明
principalId	string	系统分配标识的主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string	系统分配标识的租户 ID。此属性仅针对系统分配的标识提供。
type	ResourceIdentityType	用于资源的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从服务中删除任何标识。
userAssignedIdentities	UserAssignedIdentities	与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

PhysicalPartitionId

Object

PhysicalPartitionId 对象的数组。

名称	类型	说明
id	string	物理分区的 ID

PhysicalPartitionThroughputInfoResource

Object

物理分区吞吐量信息对象的数组

名称	类型	说明
id	string	物理分区的 ID
targetThroughput	number (double)	物理分区的目标吞吐量
throughput	number (double)	物理分区的吞吐量

PhysicalPartitionThroughputInfoResult

Object

Azure Cosmos DB PhysicalPartitionThroughputInfoResult 对象。

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
identity	ManagedServiceIdentity	资源的标识。
location	string	资源所属的资源组的位置。
name	string	ARM 资源的名称。
properties.resource	Resource	物理分区吞吐量信息的属性
tags	object	标记是描述资源的键值对的列表。这些标记可用于查看和分组此资源（跨资源组）。最多可为资源提供 15 个标记。每个标记必须具有不超过 128 个字符的键，且值不超过 256 个字符。例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
type	string	Azure 资源的类型。

Resource

Object

物理分区吞吐量信息的属性

名称	类型	说明
physicalPartitionThroughputInfo	PhysicalPartitionThroughputInfoResource[]	物理分区吞吐量信息对象的数组

ResourceIdentityType

枚举

用于资源的标识类型。类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。类型“None”将从服务中删除任何标识。

值	说明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

RetrieveThroughputParameters

Object

用于检索当前 SQL 容器的吞吐量分布的参数。

名称	类型	说明
id	string	ARM 资源的唯一资源标识符。
identity	ManagedServiceIdentity	资源的标识。
location	string	资源所属的资源组的位置。
name	string	ARM 资源的名称。
properties.resource	RetrieveThroughputPropertiesResource	资源吞吐量的标准 JSON 格式
tags	object	标记是描述资源的键值对的列表。这些标记可用于查看和分组此资源（跨资源组）。最多可为资源提供 15 个标记。每个标记必须具有不超过 128 个字符的键，且值不超过 256 个字符。例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。
type	string	Azure 资源的类型。

RetrieveThroughputPropertiesResource

Object

资源吞吐量的标准 JSON 格式

名称	类型	说明
physicalPartitionIds	PhysicalPartitionId[]	PhysicalPartitionId 对象的数组。

UserAssignedIdentities

Object

与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

名称	类型	说明

通过

Sql Resources - Sql Container Retrieve Throughput Distribution

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

CosmosDBSqlContainerRetrieveThroughputDistribution

示例请求

示例响应

定义

CloudError

ErrorResponse

ManagedServiceIdentity

PhysicalPartitionId

PhysicalPartitionThroughputInfoResource

PhysicalPartitionThroughputInfoResult

Resource

ResourceIdentityType

RetrieveThroughputParameters

RetrieveThroughputPropertiesResource

UserAssignedIdentities