AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 微服务引擎 开发参考 API参考（mse） API参考指南 API目录 云原生网关 服务管理 GetGatewayServiceDetail - 查询网关服务详情

GetGatewayServiceDetail - 查询网关服务详情

更新时间：
产品详情
我的收藏

查询服务详情。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mse:GetGatewayServiceDetail

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

 无 无

请求参数

名称

类型

必填

描述

示例值
ServiceId

integer

是

服务 ID。

35
GatewayUniqueId

string

是

网关唯一标识 ID。

gw-f4c960ad071a48a790b36324394c****
AcceptLanguage

string

否

返回信息的语言类型：

  • zh：中文

  • en：英文

zh

返回参数

名称

类型

描述

示例值

object

数据结构。

RequestId

string

请求 ID。

9802C54E-5CC5-5706-927B-993DBB6DCF2F
HttpStatusCode

integer

HTTP 状态码。

200
Message

string

返回信息。

请求处理成功
Code

integer

响应码。

1
Success

boolean

请求结果，取值如下：

  • true：请求成功。

  • false：请求失败。

true
Data

object

数据概览。

Id

integer

服务 ID。

1
Name

string

服务名称。

test
GatewayUniqueId

string

网关唯一标识 ID。

gw-7ea3da97b96543e19f6c597c****
GatewayId

integer

网关 ID。

1
SourceType

string

服务来源

MSE
Namespace

string

命名空间。

default
GroupName

string

分组名称。

test
SourceId

integer

来源 ID。

1
ServiceNameInRegistry

string

服务注册到注册中心的名称。

test
MetaInfo

string

服务的基本信息。

{}
Ips

array

服务 IP 地址。

string

IP。

127.0.1.12
Versions

array

服务版本号（已废弃）。

object

数据结构。

Label

string

标签。

version
Value

string

标签值。

v1
Type

string

类型。

test
LabelDetails

array

标签详情。

object

数据结构。

Key

string

标签。

label
Values

array

标签值。

string

标签值。

v1
VersionDetails

array

版本详细。

object

数据结构。

ServiceVersion

object

服务版本。

Name

string

版本名。

v2
Labels

array

标签。

object

数据结构。

Key

string

标签。

version
Value

string

标签值。

v2
EndpointNum

integer

实例数。

1
EndpointNumPercent

string

实例百分比。

20%
GmtCreate

string

创建时间。

2022-01-07 18:07:57
GmtModified

string

最后修改时间。

2022-01-07T10:07:57.000+0000
GatewayTrafficPolicy

服务流量策略。

{}
HealthStatus

string

健康检查状态。

true
HealthCheck

string

是否健康检查。

true
ServiceProtocol

string

服务协议。

HTTP
Ports

array

服务端口数组。

integer

服务端口。

80
PortTrafficPolicyList

array

服务端口流量策略。

object

端口流量策略对象。

Id

integer

端口配置 ID。

1
ServiceId

integer

服务 ID。

1
ServicePort

integer

服务端口。

8080
GatewayUniqueId

string

网关 UniqueId。

gw-2837hfd91h34dbg87364g*****
TrafficPolicy

流量策略。

GmtCreate

string

创建时间

1667460287386
GmtModified

string

修改时间。

1667460287386
ServiceFQDN

string

ServicePort

integer

DnsServerList

array

DNS 服务器列表（仅供 DNS 域名服务使用）

string

DNS 服务器地址（IP+端口）

1.1.1.1:80

示例

正常返回示例

JSON格式

{
  "RequestId": "9802C54E-5CC5-5706-927B-993DBB6DCF2F",
  "HttpStatusCode": 200,
  "Message": "请求处理成功",
  "Code": 1,
  "Success": true,
  "Data": {
    "Id": 1,
    "Name": "test",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
    "GatewayId": 1,
    "SourceType": "MSE",
    "Namespace": "default",
    "GroupName": "test",
    "SourceId": 1,
    "ServiceNameInRegistry": "test",
    "MetaInfo": "{}",
    "Ips": [
      "127.0.1.12"
    ],
    "Versions": [
      {
        "Label": "version",
        "Value": "v1",
        "Type": "test"
      }
    ],
    "LabelDetails": [
      {
        "Key": "label",
        "Values": [
          "v1"
        ]
      }
    ],
    "VersionDetails": [
      {
        "ServiceVersion": {
          "Name": "v2",
          "Labels": [
            {
              "Key": "version",
              "Value": "v2"
            }
          ]
        },
        "EndpointNum": 1,
        "EndpointNumPercent": "20%"
      }
    ],
    "GmtCreate": "2022-01-07 18:07:57",
    "GmtModified": "2022-01-07T10:07:57.000+0000",
    "GatewayTrafficPolicy": {
      "TlsSetting": {
        "TlsMode": "SIMPLE",
        "CertId": "6456988-cn-hangzhou",
        "CaCertContent": "-----BEGIN CERTIFICATE----- MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ 0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA 7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH 7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 -----END CERTIFICATE-----",
        "Sni": "www.aliyun.com"
      },
      "LoadBalancerSettings": {
        "LoadbalancerType": "RANDOM",
        "ConsistentHashLBConfig": {
          "ParameterName": "test",
          "HttpCookie": {
            "Name": "test",
            "Path": "/path",
            "TTL": "10s"
          },
          "ConsistentHashLBType": "QUERY_PARAMETER"
        },
        "WarmupDuration": 5
      }
    },
    "HealthStatus": "true",
    "HealthCheck": "true",
    "ServiceProtocol": "HTTP",
    "Ports": [
      80
    ],
    "PortTrafficPolicyList": [
      {
        "Id": 1,
        "ServiceId": 1,
        "ServicePort": 8080,
        "GatewayUniqueId": "gw-2837hfd91h34dbg87364g*****",
        "TrafficPolicy": {
          "TlsSetting": {
            "TlsMode": "SIMPLE",
            "CertId": "6456988-cn-hangzhou",
            "CaCertContent": "-----BEGIN CERTIFICATE----- MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ 0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA 7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH 7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 -----END CERTIFICATE-----",
            "Sni": "www.aliyun.com"
          },
          "LoadBalancerSettings": {
            "LoadbalancerType": "RANDOM",
            "ConsistentHashLBConfig": {
              "ParameterName": "test",
              "HttpCookie": {
                "Name": "test",
                "Path": "/path",
                "TTL": "10s"
              },
              "ConsistentHashLBType": "QUERY_PARAMETER"
            },
            "WarmupDuration": 5
          }
        },
        "GmtCreate": "1667460287386",
        "GmtModified": "1667460287386"
      }
    ],
    "ServiceFQDN": "",
    "ServicePort": 0,
    "DnsServerList": [
      "1.1.1.1:80"
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述
400 IllegalRequest Invalid request:%s 非法请求： %s
400 InvalidParameter Parameter error:%s 请求参数错误：%s
500 InternalError Console error. Try again later:%s 控制台错误.稍后重试：%s
403 NoPermission You are not authorized to perform this operation:%s 没有权限使用此接口：%s
404 NotFound Not found:%s 资源不存在：%s

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

变更历史

更多信息，参考变更详情。

上一篇：GetKubernetesSource - 查询ACK集群来源信息下一篇：UpdateServiceSource - 更新服务来源