文档

DescribeBackendInfo - 查询后端服务的信息

更新时间:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
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
BackendModelsobject []

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

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
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

Mock 配置信息

MockResultstring

Mock 返回结果

MockStatusCodestring

Mock 返回状态码

MockHeadersobject []

Mock 返回的 Header

HeaderNamestring

Header 参数名。

HeaderValuestring

参数对应的值。

DiscoveryConfigobject

服务发现类型后端的配置信息

RcTypestring

注册中心类型

NACOS
NacosConfigobject

Nacos 配置信息

ServerAddressstring

Nacos 服务地址

http://1xx.2xx.3xx.4xx:8848
Namespacestring

注册在 Nacos 上的微服务所在的命名空间 ID

public
GroupNamestring

注册在 Nacos 上的微服务所在的分组名称

DEFAULT_GROUP
ServiceNamestring

微服务名称

service-provider
Clustersstring

微服务所在的集群名称

cluster1
AuthTypestring

鉴权方式

PASSWORD
UserNamestring

用户名

username
Passwordstring

密码

password
AccessKeystring

具有 mse 资源管理权限的子账号的 accessKey

A5FIDxxxxxx
SecretKeystring

具有 mse 资源管理权限的子账号的 secretKey

dl5loxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "0AA90E87-3506-5AA6-AFFB-A4D53B4F6231",
  "BackendInfo": {
    "BackendName": "testoss2",
    "BackendType": "HTTP",
    "ModifiedTime": "2017-12-11T15:18:09+08:00",
    "Description": "add",
    "CreatedTime": "2021-11-22T11:10:46+08:00",
    "BackendId": "6fc978bb63574146b766863dd7bdf661",
    "BackendModels": [
      {
        "BackendModelId": "5c4995d08e8b4954b0f326e8e4f2b97d",
        "StageModeId": "6fc978bb63574146b766863dd7bdf661",
        "Description": "testDvs 1",
        "GmtCreate": "2021-12-20T03:22:03.000+0000",
        "GmtModified": "2021-12-20T03:22:03.000+0000",
        "StageName": "RELEASE",
        "BackendConfig": {
          "ServiceAddress": "10.0.0.1",
          "HttpTargetHostName": "",
          "Type": "VPC",
          "VpcConfig": {
            "VpcId": "vpc-wz9v96hqi6d14744sxqmx",
            "InstanceId": "i-uf6iaale3gfef9t9cb41",
            "Port": 8080,
            "VpcAccessId": "2zej3ehuzg9m77kvwnfpn",
            "Name": "dypls-cn-beijing-slb-pre",
            "VpcScheme": "http",
            "VpcTargetHostName": ""
          },
          "FunctionComputeConfig": {
            "FcType": "HttpTrigger",
            "FcRegionId": "cn-hangzhou",
            "ServiceName": "myservice",
            "FunctionName": "edge_function",
            "RoleArn": "acs:ram::31985*:role/aliyunserviceroleforbastionhostpam",
            "Qualifier": "testQualifier",
            "FcBaseUrl": "https://t*******.ap-*****.fcapp.run/",
            "OnlyBusinessPath": false
          },
          "OssConfig": {
            "OssRegionId": "cn-hangzhou",
            "BucketName": "my_bucket"
          },
          "EventBridgeConfig": {
            "EventBridgeRegionId": "cn-hangzhou",
            "EventSource": "dds_driver",
            "EventBus": "testBus",
            "RoleArn": "acs:ram::1975133748561***:role/aliyunserviceroleforiotlogexport"
          },
          "MockConfig": {
            "MockResult": "",
            "MockStatusCode": "",
            "MockHeaders": [
              {
                "HeaderName": "",
                "HeaderValue": ""
              }
            ]
          },
          "DiscoveryConfig": {
            "RcType": "NACOS",
            "NacosConfig": {
              "ServerAddress": "http://1xx.2xx.3xx.4xx:8848",
              "Namespace": "public",
              "GroupName": "DEFAULT_GROUP",
              "ServiceName": "service-provider",
              "Clusters": "cluster1",
              "AuthType": "PASSWORD",
              "UserName": "username",
              "Password": "password",
              "AccessKey": "A5FIDxxxxxx",
              "SecretKey": "dl5loxxxxxx"
            },
            "ZookeeperConfig": {
              "ConnectString": "",
              "Namespace": "",
              "ServiceName": ""
            }
          },
          "ServiceTimeout": 0,
          "EdasConfig": {
            "MicroserviceNamespaceName": "",
            "MicroserviceNamespaceId": "",
            "MicroserviceNamespace": "",
            "ServiceName": "",
            "EdasAppId": "",
            "RegistryType": "",
            "MseInstanceId": ""
          }
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-12-27OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-11-09OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-09-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-03OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-09-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈