调用GetServiceDetail接口获取服务详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST|GET /pop/sp/api/mseForOam/getServiceDetail HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
region | String | Query | 否 | cn-hangzhou |
地域ID。 |
namespace | String | Query | 否 | cn-hangzhou:doc-test |
命名空间ID。 |
origin | String | Query | 否 | agent |
数据来源,取值如下:
|
serviceType | String | Query | 否 | springCloud |
服务类型,取值如下:
|
appId | String | Query | 否 | efbda488-7b33-432f-a40d-****0047**** |
应用ID。 |
source | String | Query | 否 | edas |
来源,固定值:edas。 |
serviceId | String | Query | 否 | com.alibabacloud.hipstershop.CartService |
服务ID。已废弃,无需设置。 |
serviceName | String | Query | 否 | com.alibabacloud.hipstershop.CartService |
服务名称。 |
serviceVersion | String | Query | 否 | 1.0.0 |
服务版本。 |
group | String | Query | 否 | DUBBO |
服务分组。 |
ip | String | Query | 否 | 10.20.x.xx |
服务提供者IP,支持模糊查询。 |
registryType | String | Query | 否 | nacos |
注册类型。已废弃,无需设置。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | Integer | 200 |
接口请求的状态码。 |
Data | Struct |
数据结构体。 |
|
DubboApplicationName | String | cartservice |
Dubbo应用名称。 |
EdasAppName | String | test123 |
EDAS应用名称。 |
Group | String | dubbo |
分组。 |
Metadata | String | {} |
元数据。 |
Methods | Array of Method |
方法列表。 |
|
MethodController | String | com.aliware.edas.DemoController |
controller列表。 |
Name | String | feign2 |
名称。 |
NameDetail | String | test |
具体名称。 |
ParameterDefinitions | String | [{"description":"","name":"arg0","type":"java.lang.String"}] |
参数定义。 |
ParameterDetails | String | {} |
参数详情。 |
ParameterNames | String | test |
参数名称。 |
ParameterTypes | String | ["java.lang.String"] |
参数类型。 |
Paths | String | ["/consumer-echo/feign/{str}"] |
方法路径。 |
RequestMethods | String | GET |
请求方法。 |
ReturnDefinition | Struct |
返回定义。 |
|
Id | String | 1 |
返回值ID。 |
Type | String | foo |
类型。 |
ReturnDetails | String | test |
返回详情。 |
ReturnType | String | java.lang.String |
返回类型。 |
RegistryType | String | agent |
注册类型。 |
ServiceName | String | edas.service.consumer |
服务名。 |
ServiceType | String | springCloud |
服务类型。 |
SpringApplicationName | String | edas.service.consumer |
Spring应用名。 |
Version | String | 1.0.0 |
版本号。 |
Message | String | success |
接口请求返回的信息。 |
Success | Boolean | true |
调用是否成功。 |
示例
请求示例
POST /pop/sp/api/mseForOam/getServiceDetail HTTP/1.1
公共请求头
正常返回示例
XML
格式
<GetServiceDetail>
<Message>success</Message>
<Data>
<Group>dubbo</Group>
<RegistryType>agent</RegistryType>
<Version>1.0.0</Version>
<ServiceName>edas.service.consumer</ServiceName>
<ServiceType>springCloud</ServiceType>
<EdasAppName>test123</EdasAppName>
<Metadata>{}</Metadata>
<SpringApplicationName>edas.service.consumer</SpringApplicationName>
<Methods>
<ParameterDefinitions>[{"description":"","name":"arg0","type":"java.lang.String"}]</ParameterDefinitions>
<ParameterNames>test</ParameterNames>
<ParameterDetails>{}</ParameterDetails>
<MethodController>com.aliware.edas.DemoController</MethodController>
<Paths>["/consumer-echo/feign/{str}"]</Paths>
<RequestMethods>GET</RequestMethods>
<ParameterTypes>["java.lang.String"]</ParameterTypes>
<ReturnType>java.lang.String</ReturnType>
<ReturnDetails>test</ReturnDetails>
<NameDetail>test</NameDetail>
<Name>feign2</Name>
</Methods>
<Methods>
<ReturnDefinition>
<Type>foo</Type>
<Id>1</Id>
</ReturnDefinition>
</Methods>
<DubboApplicationName>cartservice</DubboApplicationName>
</Data>
<Code>200</Code>
<Success>true</Success>
</GetServiceDetail>
JSON
格式
{
"Message": "success",
"Data": {
"Group": "dubbo",
"RegistryType": "agent",
"Version": "1.0.0",
"ServiceName": "edas.service.consumer",
"ServiceType": "springCloud",
"EdasAppName": "test123",
"Metadata": "{}",
"SpringApplicationName": "edas.service.consumer",
"Methods": [
{
"ParameterDefinitions": "[{\"description\":\"\",\"name\":\"arg0\",\"type\":\"java.lang.String\"}]",
"ParameterNames": "test",
"ParameterDetails": "{}",
"MethodController": "com.aliware.edas.DemoController",
"Paths": "[\"/consumer-echo/feign/{str}\"]",
"RequestMethods": "GET",
"ParameterTypes": "[\"java.lang.String\"]",
"ReturnType": "java.lang.String",
"ReturnDetails": "test",
"NameDetail": "test",
"Name": "feign2"
},
{
"ReturnDefinition": {
"Type": "foo",
"Id": 1
}
}
],
"DubboApplicationName": "cartservice"
},
"Code": 200,
"Success": true
}
在文档使用中是否遇到以下问题
更多建议
匿名提交