GetService - 查询服务详细信息

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。

cn-hangzhou
ServiceIdstring

服务 ID。

service-0e6fca6a51a544xxxxxx
ServiceVersionstring

服务版本。

1.0
ShowDetailsarray

是否透出服务详细信息。

string

是否透出服务详细信息。

ServiceInstanceRoleInfo
ServiceNamestring

服务名称。

Wordpress社区版
ServiceInstanceIdstring

服务实例 ID。

si-b58c874912fc4294****

返回参数

名称类型描述示例值
object
Statusstring

服务状态。可能的值:

  • Draft:草稿状态。

  • Beta: 预发布状态。不允许修改,可分享给其他用户使用。

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

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

  • Launching:服务上线中。

  • Online:已上线。

  • Offline:已下线。

  • Creating: 服务创建中。

  • CreateFailed:服务创建失败。

  • Updating:服务更新中。

  • UpdateFailed:服务更新失败。

Online
DeployMetadatastring

存储服务部署配置的信息。存储的信息与部署类型有关,不同的部署类型存储的数据格式不一样,因此使用 JSON String 格式进行数据存储。

{\"TemplateUrl\": \"http://tidbRosFile\"}
PublishTimestring

发布时间。

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

请求 ID。

06BF8F22-02DC-4750-83DF-3FFC11C065EA
Versionstring

服务版本。

1.0
DeployTypestring

部署类型。可能值:

  • ros:通过 ROS 部署。

  • terraform:通过 Terraform 部署。

  • spi:调用 SPI 部署。

  • operation:代运维服务部署。

  • container:通过容器部署。

  • pkg:包服务。

ros
ServiceIdstring

服务 ID。

service-0e6fca6a51a544xxxxxx
SupplierUrlstring

服务商地址。

http://example.com
ServiceTypestring

服务类型。可能值:

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

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

  • operation:代运维服务。

private
ServiceProductUrlstring

产品页 URL。

http://example1.com
SupplierNamestring

服务商名称。

A公司
ServiceInfosarray<object>

服务信息。

ServiceInfoobject

服务信息。

Localestring

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

  • zh-CN:中文。

  • en-US:英文。

zh-CN
Imagestring

服务图标地址。

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

服务名称。

B数据库
ShortDescriptionstring

服务概述。

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

服务的协议文档信息。

Agreementsobject

服务的协议文档信息。

Namestring

协议名称。

用户协议
Urlstring

协议链接。

https://url
Softwaresarray<object>

服务软件信息。

Softwaresobject

服务软件信息。

Namestring

软件名称。

wordpress
Versionstring

软件版本。

6.0.1
IsSupportOperatedboolean

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

  • true:开启。

  • false:关闭。

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

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

policyName1, policyName2
Durationlong

代运维时间。单位:秒。

259200
ShareTypestring

共享类型。可能的值:

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

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

  • OnlyFormalRestricted:仅正式部署受限。

  • OnlyTrailRestricted:仅试用部署受限。

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

Public
Permissionstring

权限类型。可能的值:

  • Deployable:可部署。

  • Accessible:可访问。

Deployable
AlarmMetadatastring

服务报警配置。

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

版本名称。

v1
Tagsarray<object>

服务标签。

Tagobject

服务标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1
TrialDurationlong

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

7
SupplierDescstring

服务商描述。

阿里云计算巢团队
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\":{}}}
LogMetadatastring

应用日志配置。

{\"Logstores\":[]}
DeployFromstring

服务部署途径。可选值:

  • NoWhere:没有部署途径。

  • Marketplace:从云市场部署。

  • ComputeNest:从计算巢部署。

Marketplace
Categoriesstring

服务类别名称

AI
SupplierUidlong

服务商 AliUid。

158927391332*****
Commodityobject

商品规格。

Typestring

类型。

取值:

Marketplace:云市场。

Css:凌霄。

Marketplace
ChargeTypestring

付费类型。

取值:

PREPAY(默认值):预付费,即包年包月。

POSTPAY:后付费,即按量付费。

POSTPAY
OrderTimeobject

订购时间

array

订购时间

OrderTimestring

订购时间

[1:Month]
CommodityCodestring

商品规格码。

cmjj00****
Specificationsarray<object>

云市场规格详情。

Specificationsobject

云市场规格详情。

Codestring

商品 code。

cmjj00****
Namestring

规格名称。

specifications1
Timesarray

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

Timesstring

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

[1:Month]
MarketplaceMetadataobject

云市场元数据信息。

SpecificationMappingsarray<object>

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

SpecificationMappingsobject

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

SpecificationCodestring

云市场商品规格 code。

cmjj00****
TemplateNamestring

模板名称

单机版
SpecificationNamestring

套餐名称

套餐一
CssMetadataobject

凌霄配置元数据。

ComponentsMappingsarray<object>

计费项映射。

ComponentsMappingsobject

计费项映射。

TemplateNamestring

模板名称。

单机版
Mappingsobject

映射关系。

string

映射关系。

{{DBInstanceStorage}}
SaasBoostMetadatastring

SaasBoost 配置元数据。

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

部署页面

Order: 下单页 Detail: 详情页
InstanceRoleInfosarray<object>

服务模板中创建的角色信息。

InstanceRoleInfosobject
TemplateNamestring

模板名称。

模板1
RoleNamestring

角色名称。

ram-for-dts
PolicyDocumentstring

管控策略内容。

{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Principal\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n}
Principalsarray

RAM 实体信息。

Principalsstring

RAM 实体信息。

[{'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}, {'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}]
ServiceDocumentInfosarray<object>

服务文档信息。

ServiceDocumentInfosobject

服务文档信息。

Localestring

服务文档语言。可能的值:

  • zh-CN:中文。

  • en-US:英文。

zh-CN
TemplateNamestring

模板名称。

单机版
DocumentUrlstring

文档链接。

https://help.aliyun.com/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2

示例

正常返回示例

JSON格式

{
  "Status": "Online",
  "DeployMetadata": "{\\\"TemplateUrl\\\": \\\"http://tidbRosFile\\\"}",
  "PublishTime": "2021-05-21T00:00:00Z",
  "RequestId": "06BF8F22-02DC-4750-83DF-3FFC11C065EA",
  "Version": "1.0",
  "DeployType": "ros",
  "ServiceId": "service-0e6fca6a51a544xxxxxx",
  "SupplierUrl": "http://example.com",
  "ServiceType": "private",
  "ServiceProductUrl": "http://example1.com",
  "SupplierName": "A公司",
  "ServiceInfos": [
    {
      "Locale": "zh-CN",
      "Image": "https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png",
      "Name": "B数据库",
      "ShortDescription": "B是A公司自主设计并研发的开源分布式的关系型数据库",
      "Agreements": [
        {
          "Name": "用户协议",
          "Url": "https://url"
        }
      ],
      "Softwares": [
        {
          "Name": "wordpress",
          "Version": "6.0.1"
        }
      ]
    }
  ],
  "IsSupportOperated": false,
  "PolicyNames": "policyName1, policyName2",
  "Duration": 259200,
  "ShareType": "Public",
  "Permission": "Deployable",
  "AlarmMetadata": "{ \"TemplateUrl\": \"http://template.file.url\", // 应用分组级别告警元数据 \"ApplicationGroups\": [ { \"Name\": \"applicationGroup1\", \"TemplateUrl\": \"url1\" }, { \"Name\": \"applicationGroup2\", \"TemplateUrl\": \"url2\" } ] }",
  "VersionName": "v1",
  "Tags": [
    {
      "Key": "key1",
      "Value": "value1"
    }
  ],
  "TrialDuration": 7,
  "SupplierDesc": "阿里云计算巢团队",
  "TrialType": "Trial",
  "TenantType": "SingleTenant",
  "LicenseMetadata": "{\\\"PayType\\\":\\\"CustomFixTime\\\",\\\"DefaultLicenseDays\\\":7,\\\"CustomMetadata\\\":[{\\\"TemplateName\\\":\\\"模板1\\\",\\\"SpecificationName\\\":\\\"bandwith-0\\\",\\\"CustomData\\\":\\\"1\\\"}]}",
  "OperationMetadata": "{\\\"PrometheusConfigMap\\\":{\\\"New_Vpc_Ack_And_Jumpserver\\\":{}}}",
  "LogMetadata": "{\\\"Logstores\\\":[]}",
  "SupplierLogo": "https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-image/xxx.png",
  "DeployFrom": "Marketplace",
  "Categories": "AI",
  "SupplierUid": 0,
  "Commodity": {
    "Type": "Marketplace",
    "ChargeType": "POSTPAY",
    "OrderTime": {
      "key": [
        "[1:Month]"
      ]
    },
    "CommodityCode": "cmjj00****",
    "Specifications": [
      {
        "Code": "cmjj00****\n",
        "Name": "specifications1\n",
        "Times": [
          "[1:Month]"
        ]
      }
    ],
    "MarketplaceMetadata": {
      "SpecificationMappings": [
        {
          "SpecificationCode": "cmjj00****",
          "TemplateName": "单机版",
          "SpecificationName": "套餐一"
        }
      ]
    },
    "CssMetadata": {
      "ComponentsMappings": [
        {
          "TemplateName": "单机版",
          "Mappings": {
            "key": "{{DBInstanceStorage}}\n"
          }
        }
      ]
    },
    "SaasBoostMetadata": "{\n    \"Enabled\":false\n    //公网交互地址\n    \"PublicAccessUrl\":\"https://example.com\"\n}",
    "DeployPage": "Order: 下单页\nDetail: 详情页"
  },
  "InstanceRoleInfos": [
    {
      "TemplateName": "模板1",
      "RoleName": "ram-for-dts",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "Principals": [
        "[{'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}, {'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}]"
      ]
    }
  ],
  "ServiceDocumentInfos": [
    {
      "Locale": "zh-CN",
      "TemplateName": "单机版",
      "DocumentUrl": "https://help.aliyun.com/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-12-27OpenAPI 返回结构发生变更查看变更详情