首页 API 网关 开发指南 API参考指南 API目录 后端 DescribeBackendInfo - 查询后端服务的信息

DescribeBackendInfo - 查询后端服务的信息

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

调试

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

调试

授权信息

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

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

请求参数

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

后端服务ID

739b68751c0b4e899e04d0c92b6d0be7

返回参数

名称类型描述示例值
object

返回数据

RequestIdstring

请求ID

0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
BackendInfoobject

后端服务信息

BackendNamestring

后端服务名称

testoss2
BackendTypestring

后端服务类型

HTTP
ModifiedTimestring

后端服务修改时间

2017-12-11T15:18:09+08:00
Descriptionstring

描述信息

add
CreatedTimestring

后端服务创建时间

2021-11-22T11:10:46+08:00
BackendIdstring

后端服务ID

6fc978bb63574146b766863dd7bdf661
BackendModelsarray

后端服务在环境上的配置信息

object

后端服务在环境上的配置信息

BackendModelIdstring

后端服务在环境上的配置ID

5c4995d08e8b4954b0f326e8e4f2b97d
StageModeIdstring

环境ID

6fc978bb63574146b766863dd7bdf661
Descriptionstring

描述信息

testDvs 1
GmtCreatestring

创建时间

2021-12-20T03:22:03.000+0000
GmtModifiedstring

修改时间

2021-12-20T03:22:03.000+0000
StageNamestring

环境名称

RELEASE
BackendConfigobject

后端配置

ServiceAddressstring

后端服务地址

10.0.0.1
Typestring

后端服务类型。

VPC
VpcConfigobject

后端为VPC的信息

VpcIdstring

专用网络ID

vpc-wz9v96hqi6d14744sxqmx
InstanceIdstring

专用网络中的实例ID(ECS/SLB)

i-uf6iaale3gfef9t9cb41
Portlong

实例对应的端口号

8080
VpcAccessIdstring

vpc授权ID

2zej3ehuzg9m77kvwnfpn
Namestring

VPC 配置名称

dypls-cn-beijing-slb-pre
VpcSchemestring

http/https协议

http
VpcTargetHostNamestring
FunctionComputeConfigobject

后端为函数计算的信息

FcTypestring

函数计算服务类型

HttpTrigger
FcRegionIdstring

函数计算服务的区域ID。

cn-hangzhou
ServiceNamestring

函数计算定义的ServiceName

myservice
FunctionNamestring

函数计算定义的FunctionName

edge_function
RoleArnstring

Ram授权给API网关访问函数计算的arn

acs:ram::31985*:role/aliyunserviceroleforbastionhostpam
Qualifierstring

函数别名

testQualifier
FcBaseUrlstring

函数计算服务根路径

https://t*******.ap-*****.fcapp.run/
OnlyBusinessPathboolean

后端只接收业务path

false
OssConfigobject

后端为OSS的信息

OssRegionIdstring

OSS 服务地域ID

cn-hangzhou
BucketNamestring

OSS 桶名

my_bucket
EventBridgeConfigobject

后端为 EventBridge 的配置

EventBridgeRegionIdstring

事件总线服务所在区域ID

cn-hangzhou
EventSourcestring

事件来源。

dds_driver
EventBusstring

事件总线

testBus
RoleArnstring

Ram授权给EventBridge的arn

acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport
MockConfigobject
MockResultstring
MockStatusCodestring
MockHeadersarray
object
HeaderNamestring
HeaderValuestring

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-22OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 API 网关 相关技术圈