获取全球加速服务加速配置信息-DescribeUGAInstance

获取全球加速服务加速配置信息,指定实例ID返回单个实例。未指定实例ID时 指定分页参数 则按创建时间降序 返回记录

Request Parameters

Parameter nameTypeDescriptionRequired
ProjectIdstring项目ID。请参考GetProjectList接口Yes
UGAIdstring加速配置实例ID,如果传了实例ID 则返回匹配实例ID的记录;如果没传则返回 ProjectId 下全部实例且符合分页要求No
Limitint返回的最大条数,默认为100,最大值400No
Offsetint偏移量,默认为0No

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
UGAListarray全球加速实例信息列表No
TotalCountint符合条件的总数No

UGAAInfo

Parameter nameTypeDescriptionRequired
UGAIdstring加速配置实例IDYes
CNamestring加速域名,请在加速区域配置您的业务域名的CName记录值为加速域名Yes
UGANamestring加速配置名称Yes
IPListarray源站IP列表,多个值由半角英文逗号相隔No
Domainstring源站域名No
Locationstring源站所在区域,加速实例在绑定线路后会自动设置该值。console页面上通过该值过滤加速实例可以绑定的upath实例。注意:缺少该值会导致在console上无法修改线路No
UPathSetarray绑定的加速线路No
TaskSetarray端口配置信息(不再维护,建议使用ForwarderSet)No
L4ForwarderSetarrayUGA 4层转发器配置,记录接入或回源端口,接入或回源协议信息No
L7ForwarderSetarrayUGA 7层转发器配置,记录接入或回源端口,接入或回源协议信息 如绑定证书会返回证书IDNo
OutPublicIpListarray线路出口IP地址No

UGAATask

Parameter nameTypeDescriptionRequired
Portint接入端口Yes
Protocolstring转发协议,枚举值["TCP","UDP","HTTPHTTP","HTTPSHTTP","HTTPSHTTPS"]。TCP和UDP代表四层转发,其余为七层转发Yes

OutPublicIpInfo

Parameter nameTypeDescriptionRequired
IPstring 线路出口EIPNo
Areastring线路出口机房代号No

UGAL4Forwarder

Parameter nameTypeDescriptionRequired
Portint接入端口Yes
Protocolstring转发协议,枚举值["TCP","UDP","HTTPHTTP","HTTPSHTTP","HTTPSHTTPS"]。TCP和UDP代表四层转发,其余为七层转发Yes
RSPortintRSPort,源站监听端口Yes

UGAL7Forwarder

Parameter nameTypeDescriptionRequired
Portint接入端口Yes
Protocolstring转发协议,枚举值["TCP","UDP","HTTPHTTP","HTTPSHTTP","HTTPSHTTPS"]。TCP和UDP代表四层转发,其余为七层转发Yes
RSPortintRSPort,源站监听端口Yes
SSLIdstring证书IDNo
SSLNamestring证书名称No

UPathSet

Parameter nameTypeDescriptionRequired
UPathNamestringUPath名字No
UPathIdstringUPath 实例IDNo
Bandwidthint带宽 Mbps, 1~800MbpsNo
LineIdstring线路IDNo
LineFromNamestring线路起点中文名字,加速区域No
LineToNamestring线路对端中文名字,源站区域No
LineFromstring线路起点英文代号,加速区域No
LineTostring线路对端英文代号,源站区域No

Request Example

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

Response Example

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