文档

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

更新时间:

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

调试

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

授权信息

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

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

请求参数

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

服务实例 ID。

说明 输入参数时, ServiceInstanceIdMarketInstanceId其中一个参数必须填写,否则将无法查询服务实例的详细信息。
si-d6ab3a63ccbb4b17****
RegionIdstring

地域 ID。

cn-hangzhou
MarketInstanceIdstring

云市场实例 ID。

704***59

返回参数

名称类型描述示例值
object
Outputsstring

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

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

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

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

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

  • Created:已创建。

  • Deploying:部署中。

  • DeployedFailed:部署失败。

  • Deployed:已部署。

  • Upgrading:升级中。

  • Deleting:删除中。

  • Deleted:已删除。

  • DeletedFailed:删除失败。

Deployed
TemplateNamestring

模板名称。

模板1
UpdateTimestring

更新时间。

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

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

90
Parametersstring

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

{"param":"value"}
RequestIdstring

请求 ID。

4DB0F536-B3BE-4F0D-BD29-E83FB56D550C
ServiceInstanceIdstring

服务实例 ID。

si-d6ab3a63ccbb4b17****
CreateTimestring

创建时间。

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

部署实例的状态描述。

deploy successfully
Resourcesstring

资源列表。

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

服务详情。

Statusstring

服务状态。可能的值:

  • Draft:待提交注册。

  • Submited:已提交注册。

  • Approved:已通过注册审核。

  • Online:已上线。

  • Offline:已下线。

  • Deleted:已删除。

  • Launching:服务上线中。

Online
PublishTimestring

发布时间。

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

服务版本。

1
DeployMetadatastring

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

部署类型。可能值:

  • ros:通过 ROS 部署。

  • terraform:通过 Terraform 部署。

  • ack:通过 ACK 部署。

  • spi:调用 SPI 部署。

  • operation:代运维服务部署。

ros
ServiceIdstring

服务 ID。

service-9c8a3522528b4fe8****
SupplierUrlstring

服务商地址。

http://example.com
ServiceTypestring

服务类型。可能值:

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

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

  • operation:代运维服务。

private
SupplierNamestring

服务商名称。

A公司
ServiceInfosobject []

服务信息。

Localestring

服务实例语言。

zh-CN
Imagestring

服务图标地址。

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

服务名称。

B数据库
ShortDescriptionstring

服务概述。

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

服务商自定义版本名称。

版本A
UpgradeMetadatastring

升级元数据。

{ "Type": "OOS", "Description": "Changelog or something description", "SupportUpgradeFromVersions": [1, 2], "UpgradeSteps": { "PreUpgradeStage": { "Description": "初始化数据库", "Type": "RunCommand", "ResourceName": "EcsRole1", "CommandType": "runShellScript", "CommandContent": "echo hello" }, "UpgradeStage": [{ "Description": "更新EcsRole1实例", "Type": "RunCommand", "ResourceName": "EcsRole1", "ArtifactsDownloadDirectory": "/home/admin", "CommandType": "runShellScript", "CommandContent": "echo hello" }], "PostUpgradeStage": { "Description": "部署后post check", "Type": "None/RunCommand", "ResourceName": "EcsRole1", "CommandType": "runShellScript", "CommandContent": "echo hello" } } }
UpgradableServiceVersionsarray

可升级的服务版本列表。

string

可升级的服务版本号。

1
ServiceProductUrlstring

产品页 URL。

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

产品文档的 URL。

http://example.com
OperationStartTimestring

代运维开始时间。

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

代运维结束时间。

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

被代运维的服务实例 ID。

si-d6ab3a63ccbb4b17****
EnableInstanceOpsboolean

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

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

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

true
IsOperatedboolean

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

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

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

true
NetworkConfigobject

网络配置信息。

说明 该参数已废弃。
EndpointIdstring

私网连接的终端节点 ID。

说明 该参数已废弃。
ep-m5ei37240541816b****
PrivateZoneIdstring

自定义私网域名云解析 privatezone 的 ID。

说明 该参数已废弃。
cb7f214f80ac348d87daaeac1f35****
PrivateVpcConnectionsobject []

私网连接信息。

EndpointIdstring

私网连接的终端节点 ID。

ep-m5ei37240541816b****
PrivateZoneIdstring

自定义私网域名云解析 privatezone 的 ID。

cb7f214f80ac348d87daaeac1f35****
PrivateZoneNamestring

自定义域名。

test.computenest.aliyuncs.com
ConnectionConfigsobject []

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

VpcIdstring

专有网络 ID。

vpc-bp1vwnn14rqpyiczj****
SecurityGroupsarray

安全组名称。

string

安全组名称。

'sg-m5ec4mvoq9egn7xxxxxx
VSwitchesarray

虚拟交换机名称。

string

虚拟交换机名称。

vsw-uf6iqwohr05dw4mxxxxxx
IngressEndpointStatusstring

IngressEndpoint 状态。可能的值:

  • Ready(已连接)。

  • Pending(连接中)。

  • Failed(连接失败)。

  • Deleted(已删除)。

  • Deleting(删除中)。

Ready
NetworkServiceStatusstring

NetworkServiceStatus 状态。可能的值:

  • Ready(已连接)。

  • Pending(连接中)。

  • Failed(连接失败)。

  • Deleted(已删除)。

  • Deleting(删除中)。

Ready
EndpointIpsarray

私网连接终端节点 IP。

string

私网连接终端节点 IP。

192.xxx.xxx.xxx
DomainNamestring

域名名称。

ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com
RegionIdstring

基于计算巢内网互联模式构建私网互联时,终端节点所在 VPC 的地域。

cn-beijing
ConnectBandwidthinteger

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

1536Mbps
RegionIdstring

基于 PrivateLink 构建私网连接时终端节点所在的地域 ID。

cn-hangzhou
ReversePrivateVpcConnectionsobject []

反向私网连接信息。

EndpointIdstring

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

ep-m5ei42370541816b****
Tagsobject []

用户自定义标签。

Keystring

标签键。

key1
Valuestring

标签值。

value1
LicenseEndTimestring

许可到期时间。

2022-01-01T12:00:00
UserIdlong

用户的 AliUid。

130920852836****
SupplierUidlong

服务商 AliUid。

158927391332*****
EndTimestring

服务实例过期时间。

2022-01-01T12:00:00
Sourcestring

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

  • User:计算巢用户。

  • Market:云市场。

  • Supplier:计算巢服务商。

User
ServiceTypestring

服务类型。可能的值:

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

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

  • operation:代运维服务实例

  • poc:试用服务实例。

private
PayTypestring

付费类型。取值范围:

  • Permanent:永久购买。

  • Subscription:云市场包年包月。

  • PayAsYouGo:云市场按量付费。

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

Subscription
Namestring

服务实例名称。

TestName
EnableUserPrometheusboolean

是否启用 Prometheus 监控。可能的值:

  • true:启用。

  • false:不启用。

true
Componentsstring

云市场额外计费项。

{"TiKVServerCount":"3","package_version":"yuncode5398300001","PDServerCount":"3","TiDBServerCount":"2"}
PredefinedParameterNamestring

套餐名称。

套餐一
MarketInstanceIdstring

云市场实例 ID。

704***59
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4p****
BizStatusstring

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

  • Normal:正常。

  • Renewing:续费中。

  • RenewFoiled:续费失败。

  • Expired:已过期。

Normal
GrafanaDashBoardUrlstring

grafana 大盘链接。

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

示例

正常返回示例

JSON格式

{
  "Outputs": "{\"InstanceIds\":[\"i-hp38ofxl0dsyfi7z****\"]}",
  "Status": "Deployed",
  "TemplateName": "模板1",
  "UpdateTime": "2021-05-20T00:00:00Z",
  "Progress": 90,
  "Parameters": "{\"param\":\"value\"}",
  "RequestId": "4DB0F536-B3BE-4F0D-BD29-E83FB56D550C",
  "ServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "CreateTime": "2021-05-20T00:00:00Z",
  "StatusDetail": "deploy successfully",
  "Resources": "[{\"StackId\": \"stack-xxx\"}]",
  "Service": {
    "Status": "Online",
    "PublishTime": "2021-05-21T00:00:00Z",
    "Version": "1",
    "DeployMetadata": "{\"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": "ros",
    "ServiceId": "service-9c8a3522528b4fe8****",
    "SupplierUrl": "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",
    "UpgradeMetadata": "{\n  \"Type\": \"OOS\",\n  \"Description\": \"Changelog or something description\",\n  \"SupportUpgradeFromVersions\": [1, 2],\n  \"UpgradeSteps\": {\n    \"PreUpgradeStage\": {\n      \"Description\": \"初始化数据库\",\n      \"Type\": \"RunCommand\",\n      \"ResourceName\": \"EcsRole1\",\n      \"CommandType\": \"runShellScript\",\n      \"CommandContent\": \"echo hello\"\n    },\n    \"UpgradeStage\": [{\n      \"Description\": \"更新EcsRole1实例\",\n      \"Type\": \"RunCommand\",\n      \"ResourceName\": \"EcsRole1\",\n      \"ArtifactsDownloadDirectory\": \"/home/admin\",\n      \"CommandType\": \"runShellScript\",\n      \"CommandContent\": \"echo hello\"\n    }],\n    \"PostUpgradeStage\": {\n      \"Description\": \"部署后post check\",\n      \"Type\": \"None/RunCommand\",\n      \"ResourceName\": \"EcsRole1\",\n      \"CommandType\": \"runShellScript\",\n      \"CommandContent\": \"echo hello\"\n    }\n  }\n}",
    "UpgradableServiceVersions": [
      "1"
    ],
    "ServiceProductUrl": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com",
    "ServiceDocUrl": "http://example.com"
  },
  "OperationStartTime": "2021-12-29T06:48:56Z",
  "OperationEndTime": "2022-01-28T06:48:56Z",
  "OperatedServiceInstanceId": "si-d6ab3a63ccbb4b17****",
  "EnableInstanceOps": true,
  "IsOperated": true,
  "NetworkConfig": {
    "EndpointId": "ep-m5ei37240541816b****",
    "PrivateZoneId": "cb7f214f80ac348d87daaeac1f35****",
    "PrivateVpcConnections": [
      {
        "EndpointId": "ep-m5ei37240541816b****",
        "PrivateZoneId": "cb7f214f80ac348d87daaeac1f35****",
        "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": "ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com",
            "RegionId": "cn-beijing",
            "ConnectBandwidth": 0
          }
        ],
        "RegionId": "cn-hangzhou"
      }
    ],
    "ReversePrivateVpcConnections": [
      {
        "EndpointId": "ep-m5ei42370541816b****"
      }
    ]
  },
  "Tags": [
    {
      "Key": "key1",
      "Value": "value1"
    }
  ],
  "LicenseEndTime": "2022-01-01T12:00:00",
  "UserId": 0,
  "SupplierUid": 0,
  "EndTime": "2022-01-01T12:00:00",
  "Source": "User",
  "ServiceType": "private",
  "PayType": "Subscription",
  "Name": "TestName",
  "EnableUserPrometheus": true,
  "Components": "{\"TiKVServerCount\":\"3\",\"package_version\":\"yuncode5398300001\",\"PDServerCount\":\"3\",\"TiDBServerCount\":\"2\"}",
  "PredefinedParameterName": "套餐一",
  "MarketInstanceId": "704***59",
  "ResourceGroupId": "rg-bp67acfmxazb4p****",
  "BizStatus": "Normal",
  "GrafanaDashBoardUrl": "https://g.console.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-01OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-25OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-05-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-04-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-04-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-23OpenAPI 描述信息更新看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
2022-06-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-12-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈