GetService - 查询服务详细信息_计算巢服务(Compute Nest)-阿里云帮助中心

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

computenest:GetService

get

*Service

acs:computenest:{#regionId}:{#accountId}:service/{#ServiceId}

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID。	cn-hangzhou
ServiceId	string	否	服务 ID。	service-0e6fca6a51a544xxxxxx
ServiceVersion	string	否	服务版本。	1.0
ShowDetails	array	否	是否透出服务详细信息。
	string	否	是否透出服务详细信息。	ServiceInstanceRoleInfo
ServiceName	string	否	服务名称。	Wordpress社区版
ServiceInstanceId	string	否	服务实例 ID。	si-b58c874912fc4294****

返回参数

名称	类型	描述	示例值
	object
Status	string	服务状态。可能的值： Draft：草稿状态。 Beta：预发布状态。不允许修改，可分享给其他用户使用。 Submitted：已提交审核。不允许修改。 Approved：已通过审核。不允许修改，可以发布上线。 Launching：服务上线中。 Online：已上线。 Offline：已下线。 Creating：服务创建中。 CreateFailed：服务创建失败。 Updating：服务更新中。 UpdateFailed：服务更新失败。	Online
DeployMetadata	string	存储服务部署配置的信息。存储的信息与部署类型有关，不同的部署类型存储的数据格式不一样，因此使用 JSON String 格式进行数据存储。	{\"TemplateUrl\": \"http://tidbRosFile\"}
PublishTime	string	发布时间。	2021-05-21T00:00:00Z
RequestId	string	请求 ID。	06BF8F22-02DC-4750-83DF-3FFC11C065EA
Version	string	服务版本。	1.0
DeployType	string	部署类型。可能值： ros：通过 ROS 部署。 terraform：通过 Terraform 部署。 spi：调用 SPI 部署。 operation：代运维服务部署。 container：通过容器部署。 pkg：包服务。	ros
ServiceId	string	服务 ID。	service-0e6fca6a51a544xxxxxx
SupplierUrl	string	服务商地址。	http://example.com
ServiceType	string	服务类型。可能值： private：部署在用户账户下。 managed：托管在服务商账户下。 operation：代运维服务。	private
ServiceProductUrl	string	产品页 URL。	http://example1.com
SupplierName	string	服务商名称。	A公司
ServiceInfos	array<object>	服务信息。
	object	服务信息。
Locale	string	服务配置语言。可能的值： zh-CN：中文。 en-US：英文。	zh-CN
Image	string	服务图标地址。	https://example.com/service-image/c1c4a559-cc60-4af1-b976-98f356602462.png
Name	string	服务名称。	B数据库
ShortDescription	string	服务概述。	B是A公司自主设计并研发的开源分布式的关系型数据库
Agreements	array<object>	服务的协议文档信息。
	object	服务的协议文档信息。
Name	string	协议名称。	用户协议
Url	string	协议链接。	https://url
Softwares	array<object>	服务软件信息。
	object	服务软件信息。
Name	string	软件名称。	wordpress
Version	string	软件版本。	6.0.1
IsSupportOperated	boolean	是否代运维，默认为：false。可能的值： true：开启。 false：关闭。说明当 ServiceType 为 private 时需要填入该值。	false
PolicyNames	string	策略名称。单个策略名称长度不超过 128 个字符，多个名称使用英文逗号（,）分隔。暂时只支持代运维相关参数策略。	policyName1, policyName2
Duration	integer	代运维时间。单位：秒。	259200
ShareType	string	共享类型。可能的值： Public：公开的，正式部署和试用部署都不受限。 Restricted：受限的，正式部署和试用部署都受限。 OnlyFormalRestricted：仅正式部署受限。 OnlyTrailRestricted：仅试用部署受限。 Hidden：隐藏的，不可见且不可申请部署权限。	Public
Permission	string	权限类型。可能的值： Deployable：可部署。 Accessible：可访问。	Deployable
AlarmMetadata	string	服务报警配置。说明当 PolicyNames 中配置了报警权限策略后，该配置才会生效。	{ "TemplateUrl": "http://template.file.url", // 应用分组级别告警元数据 "ApplicationGroups": [ { "Name": "applicationGroup1", "TemplateUrl": "url1" }, { "Name": "applicationGroup2", "TemplateUrl": "url2" } ] }
VersionName	string	版本名称。	v1
Tags	array<object>	服务标签。
	object	服务标签。
Key	string	标签键。	key1
Value	string	标签值。	value1
TrialDuration	integer	试用时长。单位：天。试用时长的最长天数不超过 30 天。	7
SupplierDesc	string	服务商描述。	阿里云计算巢团队
TrialType	string	试用类型。可选值： Trial：支持试用。 NotTrial：不支持试用。	Trial
TenantType	string	租户类型。可选值： SingleTenant：单租户。 MultiTenant：多租户。	SingleTenant
LicenseMetadata	string	许可证元数据。	{\"PayType\":\"CustomFixTime\",\"DefaultLicenseDays\":7,\"CustomMetadata\":[{\"TemplateName\":\"模板1\",\"SpecificationName\":\"bandwith-0\",\"CustomData\":\"1\"}]}
OperationMetadata	string	代运维配置。	{\"PrometheusConfigMap\":{\"New_Vpc_Ack_And_Jumpserver\":{}}}
LogMetadata	string	应用日志配置。	{\"Logstores\":[]}
SupplierLogo	string	服务商图标。	https://service-info-public.oss-cn-hangzhou.aliyuncs.com/xxx/service-image/xxx.png
DeployFrom	string	服务部署途径。可选值： NoWhere：没有部署途径。 Marketplace：从云市场部署。 ComputeNest：从计算巢部署。	Marketplace
Categories	string	服务类别名称	AI
SupplierUid	integer	服务商 AliUid。	158927391332*****
Commodity	object	商品规格。
Type	string	类型。取值： Marketplace：云市场。 Css：凌霄。	Marketplace
ChargeType	string	付费类型。取值： PREPAY（默认值）：预付费，即包年包月。 POSTPAY：后付费，即按量付费。	POSTPAY
OrderTime	object	订购时间
	array	订购时间
CommodityCode	string	商品规格码。	cmjj00****
Specifications	array<object>	云市场规格详情。
	object	云市场规格详情。
Code	string	商品 code。	cmjj00****
Name	string	规格名称。	specifications1
Times	array	允许购买的时长。单位：周或者年。
	string	允许购买的时长。单位：周或者年。	[1:Month]
MarketplaceMetadata	object	云市场元数据信息。
SpecificationMappings	array<object>	商品规格与模板或套餐的关系。
	object	商品规格与模板或套餐的关系。
SpecificationCode	string	云市场商品规格 code。	cmjj00****
TemplateName	string	模板名称	单机版
SpecificationName	string	套餐名称	套餐一
CssMetadata	object	凌霄配置元数据。
ComponentsMappings	array<object>	计费项映射。
	object	计费项映射。
TemplateName	string	模板名称。	单机版
Mappings	object	映射关系。
	string	映射关系。	{{DBInstanceStorage}}
SaasBoostMetadata	string	SaasBoost 配置元数据。	{ "Enabled":false //公网交互地址 "PublicAccessUrl":"https://example.com" }
DeployPage	string	部署页面	Order：下单页 Detail：详情页
InstanceRoleInfos	array<object>	服务模板中创建的角色信息。
	object
TemplateName	string	模板名称。	模板1
RoleName	string	角色名称。	ram-for-dts
PolicyDocument	string	管控策略内容。	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
Principals	array	RAM 实体信息。
	string	RAM 实体信息。	[{'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}, {'PrincipalType': 'RamUser', 'PrincipalId': 'xxx'}]
ServiceDocumentInfos	array<object>	服务文档信息。
	object	服务文档信息。
Locale	string	服务文档语言。可能的值： zh-CN：中文。 en-US：英文。	zh-CN
TemplateName	string	模板名称。	单机版
DocumentUrl	string	文档链接。	https://help.aliyun.com/zh/compute-nest/use-cases/deploy-an-sd-painting-service-instance?spm=a2c4g.11186623.0.i2
SupportContacts	array<object>	服务商的联系方式
	object	服务商的联系方式
Type	string	联系方式的类型	Email
Value	string	联系方式	supplier@example.com
ComplianceMetadata	object	合规包元数据
CompliancePacks	array	合规包列表
	string	合规包	VpcDataRisk
ServiceLocaleConfigs	array<object>
	object
OriginalValue	string
ZhValue	string
EnValue	string

示例

正常返回示例

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"
    }
  ],
  "SupportContacts": [
    {
      "Type": "Email\n",
      "Value": "supplier@example.com"
    }
  ],
  "ComplianceMetadata": {
    "CompliancePacks": [
      "VpcDataRisk"
    ]
  },
  "ServiceLocaleConfigs": [
    {
      "OriginalValue": "",
      "ZhValue": "",
      "EnValue": ""
    }
  ]
}

错误码

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

变更历史

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