Obtain global acceleration service configuration information - DescribeUGAInstance

Overview

Retrieve the configuration information of the global acceleration service. If an instance ID is specified, a single instance will be returned. If no instance ID is specified, records will be returned in descending order of creation time when pagination parameters are specified.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUGAInstance`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ProjectId	string	Project ID. Please refer to the GetProjectList interface.	Yes
UGAId	string	Acceleration configuration instance ID, if the instance ID is passed, the record matching the instance ID will be returned; if not passed, all instances under ProjectId that meet the pagination requirements will be returned.	No
Limit	int	The maximum number of returned items, default is 100, maximum value is 400	No
Offset	int	Offset, default is 0	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
UGAList	array[UGAAInfo]	Global Acceleration Instance Information List	No
TotalCount	int	Total number of matches	No

Data Model

UGAAInfo

Field Name	Type	Description Information	Required
UGAId	string	Acceleration Configuration Instance ID	Yes
CName	string	For accelerated domain names, please configure the CName record value of your business domain name as the accelerated domain name in the acceleration region.	Yes
UGAName	string	Acceleration Configuration Name	Yes
IPList	array[string]	List of source station IPs, multiple values separated by a comma.	No
Domain	string	Source Domain	No
Location	string	The region where the source station is located, the acceleration instance will automatically set this value after binding the line. On the console page, this value can filter the upath instances that the acceleration instance can bind. Note: Missing this value will cause the line to be unmodifiable on the console.	No
UPathSet	array[UPathSet]	Bound Acceleration Line	No
TaskSet	array[UGAATask]	Port Configuration Information (No longer maintained, it is recommended to use ForwarderSet)	No
L4ForwarderSet	array[UGAL4Forwarder]	Configuration of UGA 4-layer forwarder, recording access or return port, access or return protocol information	No
L7ForwarderSet	array[UGAL7Forwarder]	Configuration of UGA 7-layer forwarder, recording the port for access or back-to-source, and the protocol information for access or back-to-source. If a certificate is bound, the certificate ID will be returned.	No
OutPublicIpList	array[OutPublicIpInfo]	Exit IP Address of the Line	No

UPathSet

Field Name	Type	Required
UPathName	string	No
UPathId	string	No
Bandwidth	int	No
LineId	string	No
LineFromName	string	No
LineToName	string	No
LineFrom	string	No
LineTo	string	No

UGAATask

Field Name	Type	Description Information	Required
Port	int	Access Port	Yes
Protocol	string	Forwarding protocol, enumeration values ["TCP", "UDP", "HTTPHTTP", "HTTPSHTTP", "HTTPSHTTPS"]. TCP and UDP represent layer 4 forwarding, the rest are layer 7 forwarding.	Yes

UGAL4Forwarder

Field Name	Type	Description Information	Required
Port	int	Access Port	Yes
Protocol	string	Forwarding protocol, enumeration values ["TCP", "UDP", "HTTPHTTP", "HTTPSHTTP", "HTTPSHTTPS"]. TCP and UDP represent layer 4 forwarding, the rest are layer 7 forwarding.	Yes
RSPort	int	RSPort, Source Station Listening Port	Yes

UGAL7Forwarder

Field Name	Type	Description Information	Required
Port	int	Access Port	Yes
Protocol	string	Forwarding protocol, enumeration values ["TCP", "UDP", "HTTPHTTP", "HTTPSHTTP", "HTTPSHTTPS"]. TCP and UDP represent layer 4 forwarding, the rest are layer 7 forwarding.	Yes
RSPort	int	RSPort, Source Station Listening Port	Yes
SSLId	string	Certificate ID	No
SSLName	string	Certificate Name	No

OutPublicIpInfo

Field Name	Type	Description Information	Required
IP	string	Line Back-to-Source Node EIP	No
Area	string	Back-to-source node data center code	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeUGAInstance
&ProjectId=org-xxxx
&UGAId=uga-5ygl0d
&Limit=10
&Offset=0

Response Example

{
  "Action": "DescribeUGAInstanceResponse",
  "Message": "",
  "RetCode": 0,
  "TotalCount": 1,
  "UGAList": [
    {
      "CName": "xbc287.pathx.ucloudgda.com",
      "Domain": "github.com",
      "IPList": [
        ""
      ],
      "L4ForwarderSet": [
        {
          "Port": 443,
          "Protocol": "TCP",
          "RSPort": 443
        }
      ],
      "L7ForwarderSet": [],
      "Location": "北美",
      "OutPublicIpList": [
        {
          "Area": "us-ca",
          "IP": "107.150.101.244"
        },
        {
          "Area": "us-ca",
          "IP": "107.150.102.54"
        },
        {
          "Area": "us-ca",
          "IP": "107.150.102.58"
        },
        {
          "Area": "us-ca",
          "IP": "107.150.102.63"
        },
        {
          "Area": "us-ca",
          "IP": "107.150.102.68"
        },
        {
          "Area": "us-ca",
          "IP": "107.150.102.88"
        }
      ],
      "TaskSet": [
        {
          "Port": 443,
          "Protocol": "TCP",
          "RSPort": 0
        }
      ],
      "UGAId": "uga-5ygl0d",
      "UGAName": "github加速",
      "UPathSet": [
        {
          "Bandwidth": 1,
          "LineFrom": "cn-gd",
          "LineFromName": "中国(多地)",
          "LineId": "line_cn-us-ca",
          "LineTo": "us-ca",
          "LineToName": "洛杉矶",
          "UPathId": "upath-xcacoz",
          "UPathName": "中美加速"
        }
      ]
    }
  ]
}

DescribePathXSSL DescribeUPath