文档

GetService - 查询服务详细信息

更新时间:

查询指定服务的详细信息。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
ServiceIdstring

服务 ID。

service-4ee86df83fd948******
ServiceVersionstring

服务版本。

1
ShowDetailarray

返回详细信息。

string

返回详细信息。可选值:

ServiceStatistic: 服务统计信息。

ServiceStatistic
FilterAliUidboolean

是否要过滤 AliUid

false
SharedAccountTypestring

服务共享类型,默认值为 SharedAccount。可能的值:

  • SharedAccount:普通共享类型。

  • Resell:分销共享类型。

SharedAccount

返回参数

名称类型描述示例值
object
Statusstring

服务状态。可能的值:

  • Draft:草稿状态。

  • Submitted:已提交审核。不允许修改。

  • Approved:已通过审核。不允许修改,可以发布上线。

  • Launching:服务上线中。

  • Online:已上线。

  • Offline:已下线。

Online
DeployMetadatastring

存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用 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}}]}]}
PublishTimestring

发布时间。

2021-05-21T00:00:00Z
RequestIdstring

请求 ID。

B1A0198B-F316-1B72-B8DD-28B6F6D6XXXX
Versionstring

服务版本。

1.0
DeployTypestring

部署类型。可能值:

  • ros:通过 ROS 部署。

  • terraform:通过 Terraform 部署。

  • spi:调用 SPI 部署。

  • operation:代运维服务部署。

  • container:通过容器部署。

  • pkg:包服务。

ros
ServiceIdstring

服务 ID。

service-70a3b15bb62643xxxxxx
SupplierUrlstring

服务商地址。

http://example.com
ServiceDocUrlstring

产品文档的 URL。

http://example1.com
ServiceProductUrlstring

产品页 URL。

http://example2.com
ServiceTypestring

服务类型。可能值:

  • private:部署在用户账户下。

  • managed:托管在服务商账户下。

  • operation:代运维服务。

private
SupplierNamestring

服务商名称。

A公司
ServiceInfosobject []

服务信息。

Localestring

服务配置语言。可能的值:

  • zh-CN:中文。

  • en-US:英文。

zh-CN
Imagestring

服务图标地址。

https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png
Namestring

服务名称。

B数据库
ShortDescriptionstring

服务概述。

B是A公司自主设计并研发的开源分布式的关系型数据库
LongDescriptionUrlstring

服务详细描述的地址。

https://example.com
Agreementsobject []

服务的协议文档信息。

Namestring

协议名称。

Name
Urlstring

协议链接。

https://aliyun.com/xxxxxxxx.html
CommodityCodestring

云市场商品 code。

cmjj00xxxx
IsSupportOperatedboolean

是否代运维,默认为:false。可能的值:

  • true:开启。

  • false:关闭。

说明 ServiceTypeprivate 时需要填入该值。
false
PolicyNamesstring

策略名称。单个策略名称长度不超过 128 个字符,多个名称使用英文逗号(,)分隔。暂时只支持代运维相关参数策略。

policyName1, policyName2
Durationlong

代运维时间。单位:秒。

259200
Progresslong

服务实例的部署进度,单位:%。

90
StatusDetailstring

服务状态描述。

deploy successfully
CreateTimestring

创建时间。

2021-05-20T00:00:00Z
UpdateTimestring

更新时间。

2021-05-22T00:00:00Z
ShareTypestring

共享类型。可能的值:

  • Public:公开的,正式部署和试用部署都不受限。

  • Restricted:受限的,正式部署和试用部署都受限。

  • OnlyFormalRestricted:仅正式部署受限。

  • OnlyTrailRestricted:仅试用部署受限。

  • Hidden:隐藏的,不可见且不可申请部署权限。

Public
AlarmMetadatastring

服务报警配置。

说明 PolicyNames 中配置了报警权限策略后,该配置才会生效。
{ "TemplateUrl": "http://template.file.url", // 应用分组级别告警元数据 "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] }
UpgradeMetadatastring

升级元数据。

{\"Description\":\"xxx\",\"SupportRollback\":true,\"SupportUpgradeFromVersions\":[],\"UpgradeComponents\":[\"Configuration\"]}
VersionNamestring

版本名称。

v1
PayFromTypestring

付费来源,可能的值:

  • None:不付费。

  • Marketplace:云市场付费。

  • Custom:自定义付费。

None
PayTypestring

付费类型。取值范围:

  • Permanent:永久购买。

  • Subscription:云市场包年包月。

  • PayAsYouGo:云市场按量付费。

  • CustomFixTime:商家自定义固定时长。

Permanent
DefaultLicenseDayslong

默认许可证日期。单位:天。取值范围:1~1000.

1
Tagsobject []

服务标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1
TrialDurationlong

试用时长。单位:天。试用时长的最长天数不超过 30 天。

7
TrialTypestring

试用类型。可选值:

  • Trial:支持试用。

  • NotTrial:不支持试用。

Trial
TenantTypestring

租户类型。可能的值:

  • SingleTenant:单租户。

  • MultiTenant:多租户。

SingleTenant
LicenseMetadatastring

许可证元数据。

{\"PayType\":\"CustomFixTime\",\"DefaultLicenseDays\":7,\"CustomMetadata\":[{\"TemplateName\":\"模板1\",\"SpecificationName\":\"bandwith-0\",\"CustomData\":\"1\"}]}
OperationMetadatastring

代运维配置。

{\"PrometheusConfigMap\":{\"New_Vpc_Ack_And_Jumpserver\":{}}}
TestStatusstring

测试状态。可能的值:

  • CONFIG_IS_NULL:测试配置不存在。

  • SERVICE_TEST_SUCCEED:服务测试通过。

  • SERVICE_TSET_DOING:服务测试尚未通过。

SERVICE_TEST_SUCCEED
ApprovalTypestring

服务使用申请审批类型。可能的值:

  • Manual:收到审批。

  • AutoPass:自动通过。

Manual
RegistrationIdstring

注册 ID。

sr-04056c2ab4b94bxxxxxx
ResourceGroupIdstring

资源组 ID。

rg-aekzuqyxxxxxx
Permissionstring

权限类型。可能的值:

  • Deployable:可部署。

  • Accessible:可访问。

Deployable
Statisticobject

统计信息。

AccumulativeInstanceCountinteger

累计实例数。 包含历史已删除的实例。

75
AccumulativeUserCountinteger

累计用户数。 包含历史用户。

60
DeployedServiceInstanceCountinteger

线上实例数。 当前已成功部署的实例数。

20
DeployedUserCountinteger

线上用户数。 当前已成功部署的实例对应的用户数。

10
SubmittedUsageCountinteger

待审核(Submitted 状态)的服务申请个数。

10
AccumulativePocAmountdouble

试用累计消耗金额。单位:元。

80.35
AveragePocAmountdouble

试用服务实例平均消耗金额。单位:元。

40.17
AveragePocUnitAmountdouble

试用服务实例平均单位时间消耗金额。单位:元。

167.9
AveragePocDurationdouble

试用服务实例平均时长。单位:时。

1
SourceServiceIdstring

分销源服务 ID。

service-70a3b15bb62643xxxxxx
SourceServiceVersionstring

分销源服务版本。

1
SourceSupplierNamestring

分销源服务商名称。

SourceSupplier
LogMetadatastring

应用日志配置。

{ "Logstores": [ { "LogstoreName": "access-log", "LogPath": "/home/admin/app/logs", # 对容器不需要,在YAML中配置 "FilePattern": "access.log*" # 对容器不需要,在YAML中配置 } ] }
Resellableboolean

是否支持分销。可能的值:

  • false:不支持。

  • true:支持。

false
VirtualInternetServicestring

是否是虚拟互联网服务。可能的值:

  • false:否。

  • true:是。

false
ServiceDiscoverablestring

服务是否可发现。可能的值:

  • INVISIBLE:不可发现。

  • DISCOVERABLE:可发现。

DISCOVERABLE
Categoriesstring

服务分类。

DevOps
ShareTypeStatusstring

服务共享状态。

注意 该参数已弃用。

该参数已弃用。
ServiceAuditDocumentUrlstring

服务审核文件 URL。

https://service-info-public.oss-cn-hangzhou.aliyuncs.com/1690707531xxxxxx/service-document/be3382cd-xxxx-xxxx-xxxx-f8707ec12879.docx
EntitySourceobject

上报源。

string

上报源。可能的值:

  • ComputNest:计算巢上报。

  • Custom:服务商上报。

ComputNest
CrossRegionConnectionStatusstring

商品模块绑定关系。

componesConfigs
VirtualInternetServiceIdstring

虚拟互联网服务 ID。

service-70a3b15bb62643xxxxxx
Commodityobject

商品规格。

Typestring

类型。可能的值:

  • Marketplace:云市场。

  • Css:凌霄。

Marketplace
ChargeTypestring

付费类型。取值:

  • PREPAY(默认值):预付费,即包年包月。
  • POSTPAY:后付费,即按量付费。
PREPAY
Componentsarray

商品模块。

string

商品模块。

YARN
Specificationsobject []

云市场规格详情。

Codestring

商品 code。

cmjj00xxxx
Namestring

规格名称。

specifications1
Timesarray

允许购买的时长。单位:周或者年。

string

允许购买的时长。单位:周或者年。

3
MeteringEntitiesobject []

计量项信息。

EntityIdstring

计量项 ID。

cmgjxxxxxxxx-NetworkOut
Namestring

计量项属性名称。

spring-boot-demo
MarketplaceMetadataobject

云市场元数据信息。

SpecificationMappingsobject []

商品规格与模板或套餐的关系。

SpecificationCodestring

云市场商品规格 code。

cmjj00xxxx
TemplateNamestring

模板名称。

模板1
SpecificationNamestring

套餐名称。

按量付费
TrialTypestring

试用类型。可选值:

  • Trial:支持试用。

  • NotTrial:不支持试用。

NotTrial
MeteringEntityMappingsobject []

套餐与计量维度的绑定关系。

EntityIdsstring

计量项 ID。

cmgjxxxxxxxx-NetworkOut-2
TemplateNamestring

模板名称。

模板1
SpecificationNamestring

套餐名称。

按量付费套餐
MeteringEntityExtraInfosobject []

计量项配置信息。

EntityIdstring

计量项 ID。

cmgjxxxxxxxx-NetworkOut-2
Typestring

计量指标。

AvgPod
MetricNamestring

计量指标名称。

NetworkLantency
Promqlstring

自定义 prometheus 语句。

avg_over_time(count(kube_pod_info{namespace=\"default\"})[1h:1m])
CssMetadataobject

凌霄配置元数据。

ComponentsMappingsobject []

计费项映射。

Mappingsobject

映射关系。

string

映射关系。

{{DBInstanceStorage}}
TemplateNamestring

模板名称。

模板1
CommodityCodestring

云市场商品 code。

cmjj00xxxx
SaasBoostMetadatastring

SaasBoost 配置元数据。

{ "Enabled":false //公网交互地址 "PublicAccessUrl":"https://example.com" }

示例

正常返回示例

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": "B1A0198B-F316-1B72-B8DD-28B6F6D6XXXX",
  "Version": "1.0",
  "DeployType": "ros",
  "ServiceId": "service-70a3b15bb62643xxxxxx",
  "SupplierUrl": "http://example.com",
  "ServiceDocUrl": "http://example1.com",
  "ServiceProductUrl": "http://example2.com",
  "ServiceType": "private",
  "SupplierName": "A公司",
  "ServiceInfos": [
    {
      "Locale": "zh-CN",
      "Image": "https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png",
      "Name": "B数据库",
      "ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库",
      "LongDescriptionUrl": "https://example.com",
      "Agreements": [
        {
          "Name": "Name",
          "Url": "https://aliyun.com/xxxxxxxx.html"
        }
      ]
    }
  ],
  "CommodityCode": "cmjj00xxxx",
  "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": "{\\\"Description\\\":\\\"xxx\\\",\\\"SupportRollback\\\":true,\\\"SupportUpgradeFromVersions\\\":[],\\\"UpgradeComponents\\\":[\\\"Configuration\\\"]}",
  "VersionName": "v1",
  "PayFromType": "None",
  "PayType": "Permanent",
  "DefaultLicenseDays": 1,
  "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-04056c2ab4b94bxxxxxx",
  "ResourceGroupId": "rg-aekzuqyxxxxxx",
  "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-70a3b15bb62643xxxxxx",
  "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/1690707531xxxxxx/service-document/be3382cd-xxxx-xxxx-xxxx-f8707ec12879.docx",
  "EntitySource": {
    "key": "ComputNest"
  },
  "CrossRegionConnectionStatus": "componesConfigs",
  "VirtualInternetServiceId": "service-70a3b15bb62643xxxxxx",
  "Commodity": {
    "Type": "Marketplace",
    "ChargeType": "PREPAY",
    "Components": [
      "YARN"
    ],
    "Specifications": [
      {
        "Code": "cmjj00xxxx",
        "Name": "specifications1",
        "Times": [
          "3"
        ]
      }
    ],
    "MeteringEntities": [
      {
        "EntityId": "cmgjxxxxxxxx-NetworkOut",
        "Name": "spring-boot-demo"
      }
    ],
    "MarketplaceMetadata": {
      "SpecificationMappings": [
        {
          "SpecificationCode": "cmjj00xxxx",
          "TemplateName": "模板1",
          "SpecificationName": "按量付费",
          "TrialType": "NotTrial"
        }
      ],
      "MeteringEntityMappings": [
        {
          "EntityIds": "cmgjxxxxxxxx-NetworkOut-2",
          "TemplateName": "模板1",
          "SpecificationName": "按量付费套餐"
        }
      ],
      "MeteringEntityExtraInfos": [
        {
          "EntityId": "cmgjxxxxxxxx-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": "",
          "TemplateName": "",
          "SpecificationName": ""
        }
      ],
      "MeteringEntityExtraInfos": [
        {
          "EntityId": "",
          "Type": "",
          "MetricName": "",
          "Promql": ""
        }
      ]
    },
    "CommodityCode": "cmjj00xxxx",
    "SaasBoostMetadata": "{\n    \"Enabled\":false\n    //公网交互地址\n    \"PublicAccessUrl\":\"https://example.com\"\n}"
  },
  "BuildInfo": ""
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-05-30OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-05-27OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-05-10OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-04-11OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-03-29OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-03-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-02-23OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-02-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2024-01-23OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-14OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-11OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-10-24OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-10-16OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-09-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-09-15OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-11OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:SharedAccountType
出参OpenAPI 返回结构发生变更
2023-08-03OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-10OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:FilterAliUid
2023-05-26OpenAPI 描述信息更新、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
入参OpenAPI 入参发生变更
    新增入参:ShowDetail
出参OpenAPI 返回结构发生变更
2023-05-25OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)