AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 计算巢服务 开发参考 服务商侧API参考 API目录 服务实例 GetServiceInstance - 查询服务实例的详细信息

GetServiceInstance - 查询服务实例的详细信息

更新时间：
产品详情
我的收藏

通过服务实例 ID、地域 ID查询指定服务实例的详细信息。例如，服务实例的部署状态、模板名称、服务详情等信息。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

computenestsupplier:GetServiceInstance

get

*ServiceInstance

acs:computenestsupplier:{#regionId}:{#accountId}:serviceinstance/{#ServiceInstanceId}

 无 无

请求参数

名称

类型

必填

描述

示例值
ServiceInstanceId

string

是

服务实例 ID。

si-d6ab3a63ccbb4b17****
RegionId

string

是

地域 ID。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

Status

string

服务实例的部署状态。可能值：

  • Created：已创建

  • Deploying：部署中

  • DeployedFailed：部署失败

  • Deployed：已部署

  • Upgrading：升级中

  • Deleting：删除中

  • Deleted：已删除

  • DeletedFailed：删除失败

Deployed
TemplateName

string

模板名称。

模板1
UpdateTime

string

更新时间。

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

string

请求 ID。

4DB0F536-B3BE-4F0D-BD29-E83FB56D550C
ServiceInstanceId

string

服务实例 ID。

si-d6ab3a63ccbb4b17****
CreateTime

string

创建时间。

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

integer

用户 AliUid。

1234567
SupplierUid

integer

服务商 AliUid。

1964460391538545
Service

object

服务详情。

Status

string

服务状态。可能的值：

Draft：待提交注册。

Submited：已提交注册。

Approved：已通过注册审核。

Online：已上线。

Offline：已下线。

Deleted：已删除。

Launching：服务上线中。

Online
PublishTime

string

发布时间。

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

string

服务版本。

1
DeployMetadata

string

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

{ "EstimateTime": null, "SupplierDeployMetadata": { "DeployTimeout": null }, "TemplateConfigs": [ { "Name": "模板1", "Url": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json", "PredefinedParameters": [], "AllowedRegions": [ "cn-hangzhou" ] } ] }
DeployType

string

部署类型。可能值：

  • ros：通过 ROS 部署。

  • terraform：通过 Terraform 部署。

  • ack：通过 ACK 部署。

  • spi：调用 SPI 部署。

  • operation：代运维服务部署。

ros
ServiceId

string

服务 ID。

service-9c8a3522528b4fe8****
SupplierUrl

string

服务商地址。

http://example.com
ServiceProductUrl

string

产品页 URL。

https://service-info-private.oss-cn-hangzhou.aliyuncs.com
ServiceDocUrl

string

产品文档的 URL。

http://example.com
ServiceType

string

服务类型。可能值：

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

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

  • operation：代运维服务。

private
SupplierName

string

服务商名称。

A公司
ServiceInfos

array<object>

服务信息。

object

服务信息。

Locale

string

服务实例语言。

zh-CN
Image

string

服务图标地址。

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

string

服务名称。

B数据库
ShortDescription

string

服务概述。

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

string

服务商自定义版本名称。

版本A
UpgradableServiceVersions

array

可升级的服务版本号。

string

可升级的服务版本号。

1
UpgradableServiceInfos

array<object>

可升级的服务版本信息。

object

可升级的服务版本信息。

Version

string

可升级的服务版本。

4
VersionName

string

可升级的服务版本名称。

新增参数管理功能
Parameters

string

部署服务实例输入的参数。

{ "param": "value" }
Progress

integer

服务实例的部署进度，单位：%。

90
StatusDetail

string

部署实例的状态描述。

deploy successfully
OperationStartTime

string

代运维开始时间。

2021-12-29T06:48:56Z
OperationEndTime

string

代运维结束时间。

2022-01-28T06:48:56Z
OperatedServiceInstanceId

string

被代运维的服务实例 ID。

si-d6ab3a63ccbb4b17****
IsOperated

boolean

服务实例的代运维功能是否开启。可能值：

  • true：服务实例的代运维功能已开启

  • false：服务实例的代运维功能未开启

true
EnableInstanceOps

boolean

服务实例是否有代运维功能。可能的值：

  • true：服务实例有代运维功能

  • false：服务实例没有代运维功能

true
Resources

string

资源列表。

[ { "StackId": "stack-xxx" } ]
NetworkConfig

object

网络配置信息。

说明

该参数已废弃。

EndpointServiceId

string

私网连接的终端节点服务 ID。

说明

该参数已废弃。

epsrv-5ei07324541816bxxxx
EndpointId

string

私网连接的终端节点 id。

说明

该参数已废弃。

ep-m5ei37240541816b****
PrivateVpcConnections

array<object>

私网连接信息。

array<object>

私网连接信息。

EndpointId

string

私网连接的终端节点 ID。

ep-m5ei37240541816b****
EndpointServiceId

string

私网连接的终端节点服务 ID。

epsrv-5ei07324541816bxxxx
PrivateZoneName

string

自定义域名。

test.computenest.aliyuncs.com
ConnectionConfigs

array<object>

网络配置信息。 主要用于私网连接。

object

网络配置信息。 主要用于私网连接。

VpcId

string

专有网络 ID。

vpc-bp1vwnn14rqpyiczj****
SecurityGroups

array

安全组名称。

string

安全组名称。

sg-m5ec4mvoq9egn7xxxxxx
VSwitches

array

虚拟交换机名称。

string

虚拟交换机名称。

vsw-uf6iqwohr05dw4mxxxxxx
IngressEndpointStatus

string

IngressEndpoint 状态。可能的值：

  • Ready（已连接）。

  • Pending（连接中）。

  • Failed（连接失败）。

  • Deleted（已删除）。

  • Deleting（删除中）。

Ready
NetworkServiceStatus

string

NetworkServiceStatus 状态。可能的值：

  • Ready（已连接）。

  • Pending（连接中）。

  • Failed（连接失败）。

  • Deleted（已删除）。

  • Deleting（删除中）。

Ready
EndpointIps

array

私网连接终端节点 IP。

string

私网连接终端节点 IP。

192.xxx.xxx.xxx
DomainName

string

域名名称。

example.com
ConnectBandwidth

integer

使用计算巢内网互联建立连接的限速带宽。

1536Mbps
ReversePrivateVpcConnections

array<object>

反向私网连接信息。

object

反向私网连接信息。

EndpointId

string

反向私网连接的终端节点 ID。

ep-m5ei42370541816b****
EndpointServiceId

string

私网连接的终端节点服务 ID。

epsrv-5ei07324541816bxxxx
Tags

array<object>

用户自定义标签。

object

用户自定义标签。

Key

string

标签键。

key1
Value

string

标签值。

value1
Outputs

string

创建服务实例返回的输出字段。

  • ROS 模式下，返回模板所有输出字段。

  • SPI 模式下，返回 ISV 输出字段和计算巢附加功能输出字段。

{ "InstanceIds": [ "i-hp38ofxl0dsyfi7z****" ] }
EndTime

string

服务实例过期时间。

2022-01-01T12:00:00
Source

string

服务实例来源。可能的值：

  • User：计算巢用户。

  • Market：云市场。

  • Supplier：计算巢服务商。

User
ServiceType

string

服务类型。可能的值：

  • private：部署在用户账户下的服务实例。

  • managed：托管在服务商账户下的服务实例。

  • operation：代运维服务实例

  • poc：试用服务实例。

private
PayType

string

付费类型。取值范围：

  • Permanent：永久购买。

  • Subscription：云市场包年包月。

  • PayAsYouGo：云市场按量付费。

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

Subscription
LicenseMetadata

string

许可证元数据。

{"renewType":"MONTHLY"}
Name

string

服务实例名称。

TestName
EnableUserPrometheus

boolean

用户侧是否启用 prometheus

true
RdAccountLoginUrl

string

服务实例对应的资源目录成员用户登录 url

https://signin.aliyun.com/switchRole.htm?parentAlias=1307782318217247.onaliyun.com&roleName=ResourceDirectoryAccountAccessRole
PredefinedParameterName

string

套餐名称。

套餐一
ResourceGroupId

string

资源组 ID。

rg-aekzkt5buxxxxxx
BizStatus

string

服务实例的业务状态。可能的值：

  • Normal：正常。

  • Renewing：续费中。

  • RenewFoiled：续费失败。

  • Expired：已过期。

Normal
GrafanaDashBoardUrl

string

grafana 大盘链接。

https://g.xxxxxx.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxxxx-quickstart-and-dashboard?orgId=355401&refresh=10s
OperationExtraInfo

string

代运维附加信息。

6cc5ce3590ed7f5529e85fec
PolicyNames

string

GrantedPermission

object

OperationEndTime

string

PolicyNames

string

示例

正常返回示例

JSON格式

{
  "Status": "Deployed",
  "TemplateName": "模板1",
  "UpdateTime": "2021-05-20T00:00:00Z",
  "RequestId": "\t\n4DB0F536-B3BE-4F0D-BD29-E83FB56D550C",
  "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "CreateTime": "2021-05-20T00:00:00Z",
  "UserId": 1234567,
  "SupplierUid": 1964460391538545,
  "Service": {
    "Status": "Online",
    "PublishTime": "2021-05-21T00:00:00Z",
    "Version": "1",
    "DeployMetadata": "{\n      \"EstimateTime\": null,\n      \"SupplierDeployMetadata\": {\n            \"DeployTimeout\": null\n      },\n      \"TemplateConfigs\": [\n            {\n                  \"Name\": \"模板1\",\n                  \"Url\": \"https://service-info-private.oss-cn-hangzhou.aliyuncs.com/130920852836****/template/af11ec5a-09a0-4aa7-970c-09b51e2a****.json\",\n                  \"PredefinedParameters\": [],\n                  \"AllowedRegions\": [\n                        \"cn-hangzhou\"\n                  ]\n            }\n      ]\n}",
    "DeployType": "ros",
    "ServiceId": "service-9c8a3522528b4fe8****",
    "SupplierUrl": "http://example.com",
    "ServiceProductUrl": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com",
    "ServiceDocUrl": "http://example.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公司自主设计并研发的开源分布式的关系型数据库"
      }
    ],
    "VersionName": "版本A",
    "UpgradableServiceVersions": [
      "1"
    ],
    "UpgradableServiceInfos": [
      {
        "Version": "4",
        "VersionName": "新增参数管理功能"
      }
    ]
  },
  "Parameters": "{\n      \"param\": \"value\"\n}",
  "Progress": 90,
  "StatusDetail": "deploy successfully",
  "OperationStartTime": "2021-12-29T06:48:56Z",
  "OperationEndTime": "2022-01-28T06:48:56Z",
  "OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "IsOperated": true,
  "EnableInstanceOps": true,
  "Resources": "[\n      {\n            \"StackId\": \"stack-xxx\"\n      }\n]",
  "NetworkConfig": {
    "EndpointServiceId": "epsrv-5ei07324541816bxxxx",
    "EndpointId": "ep-m5ei37240541816b****",
    "PrivateVpcConnections": [
      {
        "EndpointId": "ep-m5ei37240541816b****",
        "EndpointServiceId": "epsrv-5ei07324541816bxxxx",
        "PrivateZoneName": "test.computenest.aliyuncs.com",
        "ConnectionConfigs": [
          {
            "VpcId": "vpc-bp1vwnn14rqpyiczj****",
            "SecurityGroups": [
              "sg-m5ec4mvoq9egn7xxxxxx"
            ],
            "VSwitches": [
              "vsw-uf6iqwohr05dw4mxxxxxx"
            ],
            "IngressEndpointStatus": "Ready",
            "NetworkServiceStatus": "Ready",
            "EndpointIps": [
              "192.xxx.xxx.xxx"
            ],
            "DomainName": "example.com",
            "ConnectBandwidth": 0
          }
        ]
      }
    ],
    "ReversePrivateVpcConnections": [
      {
        "EndpointId": "ep-m5ei42370541816b****",
        "EndpointServiceId": "epsrv-5ei07324541816bxxxx"
      }
    ]
  },
  "Tags": [
    {
      "Key": "key1",
      "Value": "value1"
    }
  ],
  "Outputs": "{\n      \"InstanceIds\": [\n            \"i-hp38ofxl0dsyfi7z****\"\n      ]\n}",
  "EndTime": "2022-01-01T12:00:00",
  "Source": "User",
  "ServiceType": "private",
  "PayType": "Subscription",
  "LicenseMetadata": "{\"renewType\":\"MONTHLY\"}",
  "Name": "TestName",
  "EnableUserPrometheus": true,
  "RdAccountLoginUrl": "https://signin.aliyun.com/switchRole.htm?parentAlias=1307782318217247.onaliyun.com&roleName=ResourceDirectoryAccountAccessRole",
  "PredefinedParameterName": "套餐一",
  "ResourceGroupId": "rg-aekzkt5buxxxxxx",
  "BizStatus": "Normal",
  "GrafanaDashBoardUrl": "https://g.xxxxxx.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxxxx-quickstart-and-dashboard?orgId=355401&refresh=10s",
  "OperationExtraInfo": "6cc5ce3590ed7f5529e85fec",
  "PolicyNames": "",
  "GrantedPermission": {
    "OperationEndTime": "",
    "PolicyNames": ""
  }
}

错误码

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

变更历史

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

上一篇：UpgradeServiceInstance - 升级服务实例下一篇：ListServiceInstances - 查询服务实例列表