DescribeLivePrivateLineAreas - - Alibaba Cloud ドキュメントセンター

Queries available access points where acceleration circuits start.

Usage notes

Before you call the CreateLivePrivateLine operation, you can call this operation to query available acceleration regions, which are access points where acceleration circuits start.

QPS limit

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLivePrivateLineAreas	The operation that you want to perform. Set the value to DescribeLivePrivateLineAreas.
DomainName	String	Yes	demo.aliyundoc.com	The main streaming domain.

Response parameters

Parameter	Type	Example	Description
RequestId	String	C4865B85-664B-19D3-BB16-C62FB83C8226	The request ID.
LiveAreasList	Array of LiveArea		Details about the regions.
LiveArea
RegionType	String	domestic	The region type. Valid values: domestic: in the Chinese mainland overseas: outside the Chinese mainland
Regions	Array of Region		The regions.
Region
RegionId	String	cn-shenzhen	The region ID.
LocalName	String	China (Shenzhen)	The region name.

Examples

Sample requests

https://live.aliyuncs.com?Action=DescribeLivePrivateLineAreas&DomainName=demo.aliyundoc.com&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLivePrivateLineAreasResponse>
    <RequestId>C4865B85-664B-19D3-BB16-C62FB83C8226</RequestId>
    <LiveAreasList>
        <LiveArea>
            <RegionType>domestic</RegionType>
            <Regions>
                <Region>
                    <LocalName>China (Shenzhen)</LocalName>
                    <RegionId>cn-shenzhen</RegionId>
                </Region>
            </Regions>
        </LiveArea>
        <LiveArea>
            <RegionType>overseas</RegionType>
            <Regions>
                <Region>
                    <LocalName>Singapore</LocalName>
                    <RegionId>ap-southeast-1</RegionId>
                </Region>
            </Regions>
        </LiveArea>
    </LiveAreasList>
</DescribeLivePrivateLineAreasResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C4865B85-664B-19D3-BB16-C62FB83C8226",
  "LiveAreasList" : {
    "LiveArea" : [ {
      "RegionType" : "domestic",
      "Regions" : {
        "Region" : [ {
          "LocalName" : "China (Shenzhen)",
          "RegionId" : "cn-shenzhen"
        } ]
      }
    }, {
      "RegionType" : "overseas",
      "Regions" : {
        "Region" : [ {
          "LocalName" : "Singapore",
          "RegionId" : "ap-southeast-1"
        } ]
      }
    } ]
  }
}

Error codes

For a list of error codes, see Service error codes.

Special error codes

Error code	Error message	HTTP status code	Description
InvalidDomain.NotFound	The domain provided does not exist in our records.	404	The error message returned because the domain name is not found within your Alibaba Cloud account.
InvalidParam	Parameter invalid.	400	The error message returned because one or more parameters are invalid.
InternalError	The request processing has failed due to some unknown error.	500	The error message returned because an unknown error occurred.