调用GetService查询指定服务的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
computenestsupplier:GetService |
get |
*Service
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
ServiceId |
string |
否 |
服务 ID。 您可以通过调用ListServices - 查询服务信息获取服务 ID。 |
service-f8469d2d14eb40af**** |
ServiceVersion |
string |
否 |
服务版本。 您可以通过调用ListServices - 查询服务信息获取服务版本。 |
1 |
ShowDetail |
array |
否 |
返回详细信息。 |
|
string |
否 |
返回详细信息。 取值:ServiceStatistic,服务统计信息。 |
ServiceStatistic |
|
FilterAliUid |
boolean |
否 |
是否要过滤 AliUid。 取值:
|
false |
SharedAccountType |
string |
否 |
服务共享类型。 取值:
|
SharedAccount |
ServiceInstanceId |
string |
否 |
服务实例 Id. |
si-56eb5823dxxxx |
ServiceName |
string |
否 |
服务名称。 |
Wordpress社区版 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
Status |
string |
服务状态。 取值:
|
Online |
DeployMetadata |
string |
存储服务部署配置的信息。 存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用 JSON String 格式进行数据存储。 |
{\"TemplateConfigs\":[{\"Name\":\"模板1\",\"Url\":\"oss://computenest-test/template" + ".json?RegionId=cn-beijing\",\"PredefinedParameters\":[{\"Name\":\"低配版\"," + "\"Parameters\":{\"InstanceType\":\"ecs.g5.large\",\"DataDiskSize\":40}},{\"Name\":\"高配版\"," + "\"Parameters\":{\"InstanceType\":\"ecs.g5.large\",\"DataDiskSize\":200}}]}]} |
PublishTime |
string |
发布时间。 |
2021-05-21T00:00:00Z |
RequestId |
string |
请求 ID。 |
9AC8E73E-88DE-52C2-A29B-531FC13A5604 |
Version |
string |
服务版本。 |
1.0 |
DeployType |
string |
部署类型。 取值:
|
ros |
ServiceId |
string |
服务 ID。 |
service-ca83ff3cb6b14dbc**** |
SupplierUrl |
string |
服务商地址。 |
http://example.com |
ServiceProductUrl |
string |
产品页 URL。 |
http://example2.com |
ServiceType |
string |
服务类型。 取值:
|
private |
SupplierName |
string |
服务商名称。 |
A公司 |
ServiceInfos |
array<object> |
服务信息。 |
|
object |
服务信息。 |
||
Locale |
string |
服务配置语言。 取值:
|
zh-CN |
Image |
string |
服务图标地址。 |
https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f35660****.png |
Name |
string |
服务名称。 |
B数据库 |
ShortDescription |
string |
服务概述。 |
B是A公司自主设计并研发的开源分布式的关系型数据库 |
LongDescriptionUrl |
string |
服务详细描述的地址。 |
https://example.com |
Agreements |
array<object> |
服务的协议文档信息。 |
|
object |
服务的协议文档信息。 |
||
Name |
string |
协议名称。 |
Name |
Url |
string |
协议链接。 |
https://aliyun.com/xxxxxxxx.html |
Softwares |
array<object> |
服务中用到的软件信息。 |
|
object |
服务中用到的软件信息。 |
||
Name |
string |
软件名称。 |
MySQL |
Version |
string |
软件版本。 |
5.7 |
IsSupportOperated |
boolean |
是否代运维。 取值:
|
false |
PolicyNames |
string |
策略名称。 单个策略名称长度不超过 128 个字符,多个名称使用英文逗号(,)分隔。暂时只支持代运维相关参数策略。 |
policyName1, policyName2 |
Duration |
integer |
代运维时间。单位:秒。 |
259200 |
Progress |
integer |
服务实例的部署进度,单位:%。 |
90 |
StatusDetail |
string |
服务状态描述。 |
deploy successfully |
CreateTime |
string |
创建时间。 |
2021-05-20T00:00:00Z |
UpdateTime |
string |
更新时间。 |
2021-05-22T00:00:00Z |
ShareType |
string |
共享类型。 取值:
|
Public |
AlarmMetadata |
string |
服务报警配置。 |
{ "TemplateUrl": "http://template.file.url", // 应用分组级别告警元数据 "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] } |
UpgradeMetadata |
string |
升级元数据。 |
{\"SupportRollback\":true,\"SupportUpgradeFromVersions\":[],\"UpgradeComponents\":[\"Configuration\"]} |
VersionName |
string |
版本名称。 |
v1 |
PayFromType |
string |
付费来源。 取值:
|
None |
Tags |
array<object> |
服务标签。 |
|
object |
服务标签。 |
||
Key |
string |
标签键。 |
key1 |
Value |
string |
标签值。 |
value1 |
TrialDuration |
integer |
试用时长。单位:天。 |
7 |
TrialType |
string |
试用类型。 取值:
|
Trial |
TenantType |
string |
租户类型。 取值:
|
SingleTenant |
LicenseMetadata |
string |
许可证元数据。 |
{\"PayType\":\"CustomFixTime\",\"DefaultLicenseDays\":7,\"CustomMetadata\":[{\"TemplateName\":\"模板1\",\"SpecificationName\":\"bandwith-0\",\"CustomData\":\"1\"}]} |
OperationMetadata |
string |
代运维配置。 |
{\"PrometheusConfigMap\":{\"New_Vpc_Ack_And_Jumpserver\":{}}} |
TestStatus |
string |
测试状态。 取值:
|
SERVICE_TEST_SUCCEED |
ApprovalType |
string |
服务使用申请审批类型。 取值:
|
Manual |
RegistrationId |
string |
注册 ID。 |
sr-1b4aabc1c9eb4109**** |
ResourceGroupId |
string |
资源组 ID。 |
rg-acfm2jfvb7b**** |
Permission |
string |
权限类型。 取值:
|
Deployable |
Statistic |
object |
统计信息。 |
|
AccumulativeInstanceCount |
integer |
累计实例数。 包含历史已删除的实例。 |
75 |
AccumulativeUserCount |
integer |
累计用户数。 包含历史用户。 |
60 |
DeployedServiceInstanceCount |
integer |
线上实例数。 当前已成功部署的实例数。 |
20 |
DeployedUserCount |
integer |
线上用户数。 当前已成功部署的实例对应的用户数。 |
10 |
SubmittedUsageCount |
integer |
待审核(Submitted 状态)的服务申请个数。 |
10 |
AccumulativePocAmount |
number |
试用累计消耗金额。单位:元。 |
80.35 |
AveragePocAmount |
number |
试用服务实例平均消耗金额。单位:元。 |
40.17 |
AveragePocUnitAmount |
number |
试用服务实例平均单位时间消耗金额。单位:元。 |
167.9 |
AveragePocDuration |
number |
试用服务实例平均时长。单位:时。 |
1 |
SourceServiceId |
string |
分销源服务 ID。 |
service-70a3b15bb6264315**** |
SourceServiceVersion |
string |
分销源服务版本。 |
1 |
SourceSupplierName |
string |
分销源服务商名称。 |
SourceSupplier |
LogMetadata |
string |
应用日志配置。 |
{ "Logstores": [ { "LogstoreName": "access-log", "LogPath": "/home/admin/app/logs", # 对容器不需要,在YAML中配置 "FilePattern": "access.log*" # 对容器不需要,在YAML中配置 } ] } |
Resellable |
boolean |
是否支持分销。 取值:
|
false |
VirtualInternetService |
string |
是否是虚拟互联网服务。 取值:
|
false |
ServiceDiscoverable |
string |
服务是否可发现。 取值:
|
DISCOVERABLE |
Categories |
string |
服务分类。 |
DevOps |
ShareTypeStatus |
string |
服务共享状态。 重要 该参数已弃用。 |
该参数已弃用。 |
ServiceAuditDocumentUrl |
string |
服务审核文件 URL。 |
https://service-info-public.oss-cn-hangzhou.aliyuncs.com/169070753192****/service-document/be3382cd-e198-41a4-a697-f8707ec1****.docx |
EntitySource |
object |
上报源。 |
|
string |
上报源。 取值:
|
ComputNest |
|
CrossRegionConnectionStatus |
string |
商品模块绑定关系。 |
componesConfigs |
VirtualInternetServiceId |
string |
虚拟互联网服务 ID。 |
service-70a3b15bb6264345**** |
Commodity |
object |
商品规格。 |
|
Type |
string |
类型。 取值:
|
Marketplace |
ChargeType |
string |
付费类型。 取值:
|
PREPAY |
Components |
array |
商品模块。 |
|
string |
商品模块。 |
YARN |
|
Specifications |
array<object> |
云市场规格详情。 |
|
object |
云市场规格详情。 |
||
Code |
string |
商品 code。 |
cmjj00**** |
Name |
string |
规格名称。 |
specifications1 |
Times |
array |
允许购买的时长。单位:周或者年。 |
|
string |
允许购买的时长。单位:周或者年。 |
3 |
|
MeteringEntities |
array<object> |
计量项信息。 |
|
object |
计量项信息。 |
||
EntityId |
string |
计量项 ID。 |
cmgj5682****-NetworkOut |
Name |
string |
计量项属性名称。 |
spring-boot-demo |
MarketplaceMetadata |
object |
云市场元数据信息。 |
|
SpecificationMappings |
array<object> |
商品规格与模板或套餐的关系。 |
|
object |
商品规格与模板或套餐的关系。 |
||
SpecificationCode |
string |
云市场商品规格 code。 |
cmjj00**** |
TemplateName |
string |
模板名称。 |
模板1 |
SpecificationName |
string |
套餐名称。 |
按量付费 |
TrialType |
string |
试用类型。 取值:
|
NotTrial |
MeteringEntityMappings |
array<object> |
套餐与计量维度的绑定关系。 |
|
object |
套餐与计量维度的绑定关系。 |
||
EntityIds |
string |
计量项 ID。 |
cmgj1596****-NetworkOut-2 |
TemplateName |
string |
模板名称。 |
模板1 |
SpecificationName |
string |
套餐名称。 |
按量付费套餐 |
MeteringEntityExtraInfos |
array<object> |
计量项配置信息。 |
|
object |
计量项配置信息。 |
||
EntityId |
string |
计量项 ID。 |
cmgj1596****-NetworkOut-2 |
Type |
string |
计量指标。 |
AvgPod |
MetricName |
string |
计量指标名称。 |
NetworkLantency |
Promql |
string |
自定义 prometheus 语句。 |
avg_over_time(count(kube_pod_info{namespace=\"default\"})[1h:1m]) |
CssMetadata |
object |
凌霄配置元数据。 |
|
ComponentsMappings |
array<object> |
计费项映射。 |
|
object |
计费项映射。 |
||
Mappings |
object |
映射关系。 |
|
string |
映射关系。 |
{{DBInstanceStorage}} |
|
TemplateName |
string |
模板名称。 |
模板1 |
MeteringEntityMappings |
array<object> |
套餐与计量维度的绑定关系。 |
|
object |
套餐与计量维度的绑定关系。 |
||
EntityIds |
string |
计量项 ID。 |
cmgj0015****-Frequency-1 |
TemplateName |
string |
模板名称。 |
模板1 |
SpecificationName |
string |
套餐名称。 |
按量付费套餐 |
MeteringEntityExtraInfos |
array<object> |
计量项配置信息。 |
|
object |
计量项配置信息。 |
||
EntityId |
string |
计量项 ID。 |
cmgj0048****-Frequency-1 |
Type |
string |
计量指标。 |
ComputeNestPrometheus |
MetricName |
string |
指标名称。 |
AvgMemory |
Promql |
string |
自定义 prometheus 语句。 |
avg_over_time(count(kube_pod_info{namespace=\"default\"})[1h:1m]) |
CommodityCode |
string |
云市场商品 code。 |
cmjj00xxxx |
SaasBoostMetadata |
string |
SaasBoost 配置元数据。 |
{ "Enabled":false //公网交互地址 "PublicAccessUrl":"https://example.com" } |
BuildInfo |
string |
构建服务信息。 |
{ "RepoUrl": "https://github.com/user/repo.git", "Brancn": "main"} |
BuildParameters |
string |
构建服务参数。 |
{ "ServiceTemplateId": "st-xxxxx"} |
ComplianceMetadata |
object |
合规检查元数据。 |
|
CompliancePacks |
array |
选择的合规包。 |
|
string |
选择的合规包。 |
VpcDataRisk: VPC内数据安全风险合规包。 |
|
ServiceDocumentInfos |
array<object> |
服务文档信息。 |
|
object |
服务文档信息。 |
||
Locale |
string |
服务配置语言。可能的值:
|
zh-CN |
TemplateName |
string |
模板名称。 |
模板1 |
DocumentUrl |
string |
文档链接。 |
http://doc.com |
SupportContacts |
array<object> |
服务商联系方式 |
|
object |
服务商联系方式 |
||
Type |
string |
联系方式的类型 |
|
Value |
string |
联系方式 |
supplier@test.com |
SecretKey |
string |
服务密钥。用于数字签名加密时使用。 |
6cfc5d4649c54216**** |
ServiceLocaleConfigs |
array<object> |
服务多语言配置 |
|
object |
服务多语言配置 |
||
OriginalValue |
string |
业务信息原始数据值 |
Service Name |
ZhValue |
string |
业务信息对应的中文数据值 |
服务名称 |
EnValue |
string |
业务信息对应的英文数据值 |
Service Name |
示例
正常返回示例
JSON
格式
{
"Status": "Online",
"DeployMetadata": "{\\\"TemplateConfigs\\\":[{\\\"Name\\\":\\\"模板1\\\",\\\"Url\\\":\\\"oss://computenest-test/template\" \n + \".json?RegionId=cn-beijing\\\",\\\"PredefinedParameters\\\":[{\\\"Name\\\":\\\"低配版\\\",\" \n + \"\\\"Parameters\\\":{\\\"InstanceType\\\":\\\"ecs.g5.large\\\",\\\"DataDiskSize\\\":40}},{\\\"Name\\\":\\\"高配版\\\",\" \n + \"\\\"Parameters\\\":{\\\"InstanceType\\\":\\\"ecs.g5.large\\\",\\\"DataDiskSize\\\":200}}]}]}",
"PublishTime": "2021-05-21T00:00:00Z",
"RequestId": "9AC8E73E-88DE-52C2-A29B-531FC13A5604",
"Version": "1.0",
"DeployType": "ros",
"ServiceId": "service-ca83ff3cb6b14dbc****",
"SupplierUrl": "http://example.com",
"ServiceProductUrl": "http://example2.com",
"ServiceType": "private",
"SupplierName": "A公司",
"ServiceInfos": [
{
"Locale": "zh-CN",
"Image": "https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f35660****.png",
"Name": "B数据库",
"ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库",
"LongDescriptionUrl": "https://example.com",
"Agreements": [
{
"Name": "Name",
"Url": "https://aliyun.com/xxxxxxxx.html"
}
],
"Softwares": [
{
"Name": "MySQL",
"Version": "5.7"
}
]
}
],
"IsSupportOperated": false,
"PolicyNames": "policyName1, policyName2",
"Duration": 259200,
"Progress": 90,
"StatusDetail": "deploy successfully",
"CreateTime": "2021-05-20T00:00:00Z",
"UpdateTime": "2021-05-22T00:00:00Z",
"ShareType": "Public",
"AlarmMetadata": "{\n \"TemplateUrl\": \"http://template.file.url\",\n // 应用分组级别告警元数据\n \"ApplicationGroups\": [\n {\n \"Name\": \"applicationGroup1\",\n \"TemplateUrl\": \"url1\"\n },\n {\n \"Name\": \"applicationGroup2\",\n \"TemplateUrl\": \"url2\"\n }\n ]\n}",
"UpgradeMetadata": "{\\\"SupportRollback\\\":true,\\\"SupportUpgradeFromVersions\\\":[],\\\"UpgradeComponents\\\":[\\\"Configuration\\\"]}",
"VersionName": "v1",
"PayFromType": "None",
"Tags": [
{
"Key": "key1",
"Value": "value1"
}
],
"TrialDuration": 7,
"TrialType": "Trial",
"TenantType": "SingleTenant",
"LicenseMetadata": "{\\\"PayType\\\":\\\"CustomFixTime\\\",\\\"DefaultLicenseDays\\\":7,\\\"CustomMetadata\\\":[{\\\"TemplateName\\\":\\\"模板1\\\",\\\"SpecificationName\\\":\\\"bandwith-0\\\",\\\"CustomData\\\":\\\"1\\\"}]}",
"OperationMetadata": "{\\\"PrometheusConfigMap\\\":{\\\"New_Vpc_Ack_And_Jumpserver\\\":{}}}",
"TestStatus": "SERVICE_TEST_SUCCEED",
"ApprovalType": "Manual",
"RegistrationId": "sr-1b4aabc1c9eb4109****",
"ResourceGroupId": "rg-acfm2jfvb7b****",
"Permission": "Deployable",
"Statistic": {
"AccumulativeInstanceCount": 75,
"AccumulativeUserCount": 60,
"DeployedServiceInstanceCount": 20,
"DeployedUserCount": 10,
"SubmittedUsageCount": 10,
"AccumulativePocAmount": 80.35,
"AveragePocAmount": 40.17,
"AveragePocUnitAmount": 167.9,
"AveragePocDuration": 1
},
"SourceServiceId": "service-70a3b15bb6264315****",
"SourceServiceVersion": "1",
"SourceSupplierName": "SourceSupplier",
"LogMetadata": "{\n \"Logstores\": [\n {\n \t\"LogstoreName\": \"access-log\",\n \t\t\"LogPath\": \"/home/admin/app/logs\", # 对容器不需要,在YAML中配置\n \t\t\"FilePattern\": \"access.log*\" # 对容器不需要,在YAML中配置\n }\n ]\n}",
"Resellable": false,
"VirtualInternetService": "false",
"ServiceDiscoverable": "DISCOVERABLE",
"Categories": "DevOps",
"ShareTypeStatus": "该参数已弃用。",
"ServiceAuditDocumentUrl": "https://service-info-public.oss-cn-hangzhou.aliyuncs.com/169070753192****/service-document/be3382cd-e198-41a4-a697-f8707ec1****.docx",
"EntitySource": {
"key": "ComputNest"
},
"CrossRegionConnectionStatus": "componesConfigs",
"VirtualInternetServiceId": "service-70a3b15bb6264345****",
"Commodity": {
"Type": "Marketplace",
"ChargeType": "PREPAY",
"Components": [
"YARN"
],
"Specifications": [
{
"Code": "cmjj00****",
"Name": "specifications1",
"Times": [
"3"
]
}
],
"MeteringEntities": [
{
"EntityId": "cmgj5682****-NetworkOut",
"Name": "spring-boot-demo"
}
],
"MarketplaceMetadata": {
"SpecificationMappings": [
{
"SpecificationCode": "cmjj00****",
"TemplateName": "模板1",
"SpecificationName": "按量付费",
"TrialType": "NotTrial"
}
],
"MeteringEntityMappings": [
{
"EntityIds": "cmgj1596****-NetworkOut-2",
"TemplateName": "模板1",
"SpecificationName": "按量付费套餐"
}
],
"MeteringEntityExtraInfos": [
{
"EntityId": "cmgj1596****-NetworkOut-2",
"Type": "AvgPod",
"MetricName": "NetworkLantency",
"Promql": "avg_over_time(count(kube_pod_info{namespace=\\\"default\\\"})[1h:1m])"
}
]
},
"CssMetadata": {
"ComponentsMappings": [
{
"Mappings": {
"key": "{{DBInstanceStorage}}"
},
"TemplateName": "模板1"
}
],
"MeteringEntityMappings": [
{
"EntityIds": "cmgj0015****-Frequency-1",
"TemplateName": "模板1",
"SpecificationName": "按量付费套餐"
}
],
"MeteringEntityExtraInfos": [
{
"EntityId": "cmgj0048****-Frequency-1",
"Type": "ComputeNestPrometheus",
"MetricName": "AvgMemory",
"Promql": "avg_over_time(count(kube_pod_info{namespace=\\\"default\\\"})[1h:1m])"
}
]
},
"CommodityCode": "cmjj00xxxx",
"SaasBoostMetadata": "{\n \"Enabled\":false\n //公网交互地址\n \"PublicAccessUrl\":\"https://example.com\"\n}"
},
"BuildInfo": "{ \"RepoUrl\": \"https://github.com/user/repo.git\", \"Brancn\": \"main\"}",
"BuildParameters": "{ \"ServiceTemplateId\": \"st-xxxxx\"}",
"ComplianceMetadata": {
"CompliancePacks": [
"VpcDataRisk: VPC内数据安全风险合规包。"
]
},
"ServiceDocumentInfos": [
{
"Locale": "zh-CN",
"TemplateName": "模板1",
"DocumentUrl": "http://doc.com"
}
],
"SupportContacts": [
{
"Type": "Email",
"Value": "supplier@test.com"
}
],
"SecretKey": "6cfc5d4649c54216****",
"ServiceLocaleConfigs": [
{
"OriginalValue": "Service Name\n",
"ZhValue": "服务名称",
"EnValue": "Service Name\n"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。