调用DescribeBackendInfo查询后端服务的信息

查询后端服务的信息以及在各个环境上配置的后端地址。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeBackendInfo	Read	ApiGateway acs:apigateway::{#accountId}:	无	无

请求参数

名称	类型	必填	描述	示例值
BackendId	string	否	后端服务ID	739b68751c0b4e899e04d0c92b6d0be7

返回参数

名称	类型	描述	示例值
	object	返回数据
RequestId	string	请求ID	0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
BackendInfo	object	后端服务信息
BackendName	string	后端服务名称	testoss2
BackendType	string	后端服务类型	HTTP
ModifiedTime	string	后端服务修改时间	2017-12-11T15:18:09+08:00
Description	string	描述信息	add
CreatedTime	string	后端服务创建时间	2021-11-22T11:10:46+08:00
BackendId	string	后端服务ID	6fc978bb63574146b766863dd7bdf661
BackendModels	array	后端服务在环境上的配置信息
	object	后端服务在环境上的配置信息
BackendModelId	string	后端服务在环境上的配置ID	5c4995d08e8b4954b0f326e8e4f2b97d
StageModeId	string	环境ID	6fc978bb63574146b766863dd7bdf661
Description	string	描述信息	testDvs 1
GmtCreate	string	创建时间	2021-12-20T03:22:03.000+0000
GmtModified	string	修改时间	2021-12-20T03:22:03.000+0000
StageName	string	环境名称	RELEASE
BackendConfig	object	后端配置
ServiceAddress	string	后端服务地址	10.0.0.1
Type	string	后端服务类型。	VPC
VpcConfig	object	后端为VPC的信息
VpcId	string	专用网络ID	vpc-wz9v96hqi6d14744sxqmx
InstanceId	string	专用网络中的实例ID（ECS/SLB）	i-uf6iaale3gfef9t9cb41
Port	long	实例对应的端口号	8080
VpcAccessId	string	vpc授权ID	2zej3ehuzg9m77kvwnfpn
Name	string	VPC 配置名称	dypls-cn-beijing-slb-pre
VpcScheme	string	http/https协议	http
VpcTargetHostName	string
FunctionComputeConfig	object	后端为函数计算的信息
FcType	string	函数计算服务类型	HttpTrigger
FcRegionId	string	函数计算服务的区域ID。	cn-hangzhou
ServiceName	string	函数计算定义的ServiceName	myservice
FunctionName	string	函数计算定义的FunctionName	edge_function
RoleArn	string	Ram授权给API网关访问函数计算的arn	acs:ram::31985*:role/aliyunserviceroleforbastionhostpam
Qualifier	string	函数别名	testQualifier
FcBaseUrl	string	函数计算服务根路径	https://t*****.ap-***.fcapp.run/
OnlyBusinessPath	boolean	后端只接收业务path	false
OssConfig	object	后端为OSS的信息
OssRegionId	string	OSS 服务地域ID	cn-hangzhou
BucketName	string	OSS 桶名	my_bucket
EventBridgeConfig	object	后端为 EventBridge 的配置
EventBridgeRegionId	string	事件总线服务所在区域ID	cn-hangzhou
EventSource	string	事件来源。	dds_driver
EventBus	string	事件总线	testBus
RoleArn	string	Ram授权给EventBridge的arn	acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport
MockConfig	object
MockResult	string
MockStatusCode	string
MockHeaders	array
	object
HeaderName	string
HeaderValue	string

错误码

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

变更历史

变更时间

变更内容概要

操作

2022-09-22

OpenAPI 返回结构发生变更

变更项	变更内容
出参	OpenAPI 返回结构发生变更