GetOriginPool - 查询单个源地址池

根据源地址池ID获取单条源地址池信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
esa:GetOriginPoolget
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

名称类型必填描述示例值
Idlong

源地址池 ID,可通过调用 ListOriginPools 接口获取。

1038520525196928
SiteIdlong

站点 ID,可通过调用 ListSites 接口获取。

216558609793952

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
Idlong

源地址池 ID。

103852052519****
Namestring

源地址池名称,一个站点下源地址池名称唯一。

pool1
SiteIdlong

源地址池所属的站点 ID。

21655860979****
RecordNamestring

为源地址池分配的域名,可以用来作站点下记录的源站地址。

pool1.example.com
Enabledboolean

源地址池是否启用:

  • true: 启用;
  • false:不启用。
true
Referencesobject

源地址池被引用信息,源地址池被负载均衡器配置或者被记录配置为源站时,被认为是引用。

LoadBalancersarray<object>

使用此源地址池的负载均衡器列表。

LoadBalancerobject

使用此源地址池的负载均衡器信息。

Namestring

负载均衡器名字。

lb1.example.com
Idlong

负载均衡器 ID。

99874066052****
DnsRecordsarray<object>

使用此源地址池为源站的七层记录列表。

DnsRecordobject

使用此源地址池为源站的七层记录信息。

Namestring

记录名称。

www.example.com
Idlong

记录 ID。

104285288635****
IPARecordsarray<object>

使用此源地址池为源站的四层记录列表。

IPARecordobject

使用此源地址池为源站的四层记录信息。

Namestring

记录名称。

ipa.example.com
Idlong

记录 ID。

104285288635****
ReferenceLBCountinteger

被多少个负载均衡器引用。

5
Originsarray<object>

源地址池里添加的源站信息。

Originobject

源地址池里添加的源站信息。

Idlong

源站 ID。

99750209487****
Namestring

源站名称。

origin1
Addressstring

源站地址,如:www.example.com。

www.example.com
Enabledboolean

源站是否启用:

  • true: 启用;
  • false:不启用。
true
Weightinteger

权重,0-100 的整数。

50
Typestring

源站类型:

  • ip_domain: ip 或域名类型源站;
  • OSS:OSS 地址源站;
  • S3:AWS S3 源站。
ip_domain
Headerany

回源时带的请求头,只支持 Host。

{ "Host": [ "example.com" ] }
AuthConfobject

鉴权信息,源站为 OSS 或者 S3 等源站需要鉴权时,需要传鉴权相关配置信息。

AuthTypestring

鉴权类型。

  • public:公共读写,源站为 OSS 或 S3 且为公共读写时使用;
  • private_same_account:私有同账号,源站为 OSS,且鉴权类型为同账号私有鉴权时使用;
  • private_cross_account:私有跨账号,源站为 OSS,且鉴权类型为跨账号私有鉴权时使用;
  • private:源站为 S3,且鉴权类型为私有时使用。
public
AccessKeystring

AuthType 取值为 private_cross_account 或 private 时需要传的 AccessKey。

yourAccessKeyID
SecretKeystring

AuthType 取值为 private_cross_account 或 private 时需要传的 SecretKey。

yourAccessKeySecret
Versionstring

源站为 AWS S3 时需要传的签名版本。

v4
Regionstring

源站为 AWS S3 时需要传的源站 Region。

us-east-1

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Id": 0,
  "Name": "pool1",
  "SiteId": 0,
  "RecordName": "pool1.example.com",
  "Enabled": true,
  "References": {
    "LoadBalancers": [
      {
        "Name": "lb1.example.com",
        "Id": 0
      }
    ],
    "DnsRecords": [
      {
        "Name": "www.example.com",
        "Id": 0
      }
    ],
    "IPARecords": [
      {
        "Name": "ipa.example.com",
        "Id": 0
      }
    ]
  },
  "ReferenceLBCount": 5,
  "Origins": [
    {
      "Id": 0,
      "Name": "origin1",
      "Address": "www.example.com",
      "Enabled": true,
      "Weight": 50,
      "Type": "ip_domain",
      "Header": {
        "Host": [
          "example.com"
        ]
      },
      "AuthConf": {
        "AuthType": "public",
        "AccessKey": "yourAccessKeyID",
        "SecretKey": "yourAccessKeySecret",
        "Version": "v4",
        "Region": "us-east-1\n"
      }
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InternalExceptionFailed to call the service. Try again later or contact technical support.调用服务失败,请稍后重试或联系客服咨询详情。
400OriginPoolNotExistThe specified origin pool does not exist or does not belong to your account or website. Check and try again.传入的源地址池不存在,或该地址池不属于当前用户和站点,请您确认后重试。
404SiteNotFoundThe website does not exist or does not belong to you.站点不存在,或者不属于你。

访问错误中心查看更多错误码。