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

Origin Groups - List By Endpoint

列出终结点中的所有现有源组。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/originGroups?api-version=2021-06-01

URI 参数

Name In Required Type Description
endpointName
path True
  • string

全局唯一的配置文件下的终结点的名称。

profileName
path True
  • string

资源组中唯一的CDN配置文件的名称。

resourceGroupName
path True
  • string

Azure 订阅中的资源组的名称。

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

Azure 订阅 ID。

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。 当前版本为 2021-06-01。

响应

Name Type Description
200 OK

没问题。 请求已成功。

Other Status Codes

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

OriginsGroups_ListByEndpoint

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups?api-version=2021-06-01

Sample Response

{
  "value": [
    {
      "name": "origingroup1",
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/originGroups/originGroup1",
      "type": "Microsoft.Cdn/profiles/endpoints/origingroups",
      "properties": {
        "provisioningState": "Succeeded",
        "resourceState": "Active",
        "healthProbeSettings": {
          "probePath": "/health.aspx",
          "probeRequestType": "GET",
          "probeProtocol": "Http",
          "probeIntervalInSeconds": 120
        },
        "origins": [
          {
            "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/origins/origin1"
          }
        ],
        "responseBasedOriginErrorDetectionSettings": {
          "responseBasedDetectedErrorTypes": "TcpErrorsOnly",
          "responseBasedFailoverThresholdPercentage": 10
        }
      }
    }
  ]
}

定义

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

HealthProbeParameters

包含将运行状况探测发送到源的属性的 JSON 对象。

HealthProbeRequestType

发出的运行状况探测请求的类型。

HttpErrorRangeParameters

表示 http 状态代码范围的 JSON 对象

IdentityType

创建/修改资源的标识类型

OriginGroup

当无法从CDN提供内容时,源组用于对源进行负载均衡。

OriginGroupListResult

列出源组的请求的结果。 它包含源组对象列表和用于获取下一组结果的 URL 链接。

OriginGroupProvisioningState

源组的预配状态。

OriginGroupResourceState

源组的资源状态。

ProbeProtocol

用于运行状况探测的协议。

ResourceReference

对另一个资源的引用。

ResponseBasedDetectedErrorTypes

实际用户请求的响应错误类型,其中源被视为不正常

ResponseBasedOriginErrorDetectionParameters

包含用于使用真实请求/响应确定源运行状况的属性的 JSON 对象。

SystemData

只读系统数据

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

HealthProbeParameters

包含将运行状况探测发送到源的属性的 JSON 对象。

Name Type Description
probeIntervalInSeconds
  • integer

运行状况探测之间的秒数。默认值为 240 秒。

probePath
  • string

相对于用于确定源运行状况的源的路径。

probeProtocol

用于运行状况探测的协议。

probeRequestType

发出的运行状况探测请求的类型。

HealthProbeRequestType

发出的运行状况探测请求的类型。

Name Type Description
GET
  • string
HEAD
  • string
NotSet
  • string

HttpErrorRangeParameters

表示 http 状态代码范围的 JSON 对象

Name Type Description
begin
  • integer

http 状态代码范围的非独占开始。

end
  • integer

http 状态代码范围的非独占结束。

IdentityType

创建/修改资源的标识类型

Name Type Description
application
  • string
key
  • string
managedIdentity
  • string
user
  • string

OriginGroup

当无法从CDN提供内容时,源组用于对源进行负载均衡。

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.healthProbeSettings

运行状况探测设置到用于确定源运行状况的源。

properties.origins

通过给定源组中的CDN传送的内容的源。

properties.provisioningState

源组的预配状态。

properties.resourceState

源组的资源状态。

properties.responseBasedOriginErrorDetectionSettings

包含用于使用真实请求/响应确定源运行状况的属性的 JSON 对象。 目前不支持此属性。

properties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes
  • integer

当运行不正常的终结点或添加新终结点时,将流量逐渐转移到终结点的时间(以分钟为单位)。 默认值为 10 分钟。 目前不支持此属性。

systemData

只读系统数据

type
  • string

资源类型。

OriginGroupListResult

列出源组的请求的结果。 它包含源组对象列表和用于获取下一组结果的 URL 链接。

Name Type Description
nextLink
  • string

获取下一组源对象的 URL(如果有)。

value

终结点中CDN源组的列表

OriginGroupProvisioningState

源组的预配状态。

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

OriginGroupResourceState

源组的资源状态。

Name Type Description
Active
  • string
Creating
  • string
Deleting
  • string

ProbeProtocol

用于运行状况探测的协议。

Name Type Description
Http
  • string
Https
  • string
NotSet
  • string

ResourceReference

对另一个资源的引用。

Name Type Description
id
  • string

资源 ID。

ResponseBasedDetectedErrorTypes

实际用户请求的响应错误类型,其中源被视为不正常

Name Type Description
None
  • string
TcpAndHttpErrors
  • string
TcpErrorsOnly
  • string

ResponseBasedOriginErrorDetectionParameters

包含用于使用真实请求/响应确定源运行状况的属性的 JSON 对象。

Name Type Description
httpErrorRanges

被视为源服务器错误的 Http 状态代码范围的列表,并且标记为不正常。

responseBasedDetectedErrorTypes

实际用户请求的响应错误类型,其中源被视为不正常

responseBasedFailoverThresholdPercentage
  • integer

故障转移应触发的示例中失败请求的百分比。

SystemData

只读系统数据

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC)

createdBy
  • string

创建资源的标识的标识符

createdByType

创建资源的标识的类型

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识的标识符

lastModifiedByType

上次修改资源的标识的类型