通过地域ID、服务实例iD或者云市场实例ID、查询服务实例的详细信息,例如服务状态、模板名称、资源列表等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
computenest:GetServiceInstance |
get |
*ServiceInstance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ServiceInstanceId |
string |
否 |
服务实例 ID。 说明
输入参数时, |
si-d6ab3a63ccbb4b17**** |
| RegionId |
string |
是 |
地域 ID。 |
cn-hangzhou |
| MarketInstanceId |
string |
否 |
云市场实例 ID。 |
704***59 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Outputs |
string |
创建服务实例返回的输出字段。
|
{"InstanceIds":["i-hp38ofxl0dsyfi7z****"]} |
| Status |
string |
服务实例的部署状态。可能值:
|
Deployed |
| TemplateName |
string |
模板名称。 |
模板1 |
| UpdateTime |
string |
更新时间。 |
2021-05-20T00:00:00Z |
| Progress |
integer |
服务实例的部署进度,单位:%。 |
90 |
| Parameters |
string |
部署服务实例输入的参数。 |
{"param":"value"} |
| RequestId |
string |
请求 ID。 |
4DB0F536-B3BE-4F0D-BD29-E83FB56D550C |
| ServiceInstanceId |
string |
服务实例 ID。 |
si-d6ab3a63ccbb4b17**** |
| CreateTime |
string |
创建时间。 |
2021-05-20T00:00:00Z |
| StatusDetail |
string |
部署实例的状态描述。 |
deploy successfully |
| Resources |
string |
资源列表。 |
[{"StackId": "stack-xxx"}] |
| Service |
object |
服务详情。 |
|
| Status |
string |
服务状态。可能的值:
|
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 |
| ServiceId |
string |
服务 ID。 |
service-9c8a3522528b4fe8**** |
| SupplierUrl |
string |
服务商地址。 |
http://example.com |
| ServiceType |
string |
服务类型。可能值:
|
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 |
| UpgradeMetadata |
string |
升级元数据。 |
{ "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" } } } |
| UpgradableServiceVersions |
array |
可升级的服务版本列表。 |
|
|
string |
可升级的服务版本号。 |
1 |
|
| UpgradableServiceInfos |
array<object> |
可升级的服务版本信息。 |
|
|
object |
可升级的服务版本信息。 |
||
| Version |
string |
服务版本。 |
draft |
| VersionName |
string |
版本名称。 |
20241112 |
| ServiceProductUrl |
string |
产品页 URL。 |
https://service-info-private.oss-cn-hangzhou.aliyuncs.com |
| ServiceDocUrl |
string |
产品文档的 URL。 |
http://example.com |
| OperationMetadata |
string |
运维操作相关参数,包括变配、prometheus、日志配置等 |
{"SupportBackup":false,"PrometheusConfigMap":{},"ModifyParametersConfig":[{"TemplateName":"国内版","Operation":[{"Name":"套餐变配","Description":"套餐变配","Type":"Custom","SupportPredefinedParameters":true,"EnableLogging":false},{"Name":"参数变配","Description":"参数变配","Type":"Custom","SupportPredefinedParameters":false,"EnableLogging":false,"Parameters":["DataDiskSize"]}]}]} |
| OperationStartTime |
string |
代运维开始时间。 |
2021-12-29T06:48:56Z |
| OperationEndTime |
string |
代运维结束时间。 |
2022-01-28T06:48:56Z |
| OperatedServiceInstanceId |
string |
被代运维的服务实例 ID。 |
si-d6ab3a63ccbb4b17**** |
| EnableInstanceOps |
boolean |
服务实例是否有代运维功能。可能的值:
|
true |
| IsOperated |
boolean |
服务实例的代运维功能是否开启。可能的值:
|
true |
| NetworkConfig |
object |
网络配置信息。 说明
该参数已废弃。 |
|
| EndpointId |
string |
私网连接的终端节点 ID。 说明
该参数已废弃。 |
ep-m5ei37240541816b**** |
| PrivateZoneId |
string |
自定义私网域名云解析 privatezone 的 ID。 说明
该参数已废弃。 |
cb7f214f80ac348d87daaeac1f35**** |
| PrivateVpcConnections |
array<object> |
私网连接信息。 |
|
|
array<object> |
私网连接信息。 |
||
| EndpointId |
string |
私网连接的终端节点 ID。 |
ep-m5ei37240541816b**** |
| PrivateZoneId |
string |
自定义私网域名云解析 privatezone 的 ID。 |
cb7f214f80ac348d87daaeac1f35**** |
| 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 |
| NetworkServiceStatus |
string |
NetworkServiceStatus 状态。可能的值:
|
Ready |
| EndpointIps |
array |
私网连接终端节点 IP。 |
|
|
string |
私网连接终端节点 IP。 |
192.xxx.xxx.xxx |
|
| DomainName |
string |
域名名称。 |
ie-569a9be34f5534f6bc6559b5c1xxxxxx.service-51f80502802e48xxxxxx.cn-hangzhou.computenest.aliyuncs.com |
| RegionId |
string |
基于计算巢内网互联模式构建私网互联时,终端节点所在 VPC 的地域。 |
cn-beijing |
| ConnectBandwidth |
integer |
使用计算巢内网互联建立连接的限速带宽。 |
1536Mbps |
| RegionId |
string |
基于 PrivateLink 构建私网连接时终端节点所在的地域 ID。 |
cn-hangzhou |
| ReversePrivateVpcConnections |
array<object> |
反向私网连接信息。 |
|
|
object |
反向私网连接信息。 |
||
| EndpointId |
string |
反向私网连接的终端节点 ID。 |
ep-m5ei42370541816b**** |
| Tags |
array<object> |
用户自定义标签。 |
|
|
object |
用户自定义标签。 |
||
| Key |
string |
标签键。 |
key1 |
| Value |
string |
标签值。 |
value1 |
| LicenseEndTime |
string |
许可到期时间。 |
2022-01-01T12:00:00 |
| UserId |
integer |
用户的 AliUid。 |
130920852836**** |
| SupplierUid |
integer |
服务商 AliUid。 |
158927391332***** |
| EndTime |
string |
服务实例过期时间。 |
2022-01-01T12:00:00 |
| Source |
string |
服务实例来源。可能的值:
|
User |
| ServiceType |
string |
服务类型。可能的值:
|
private |
| PayType |
string |
付费类型。取值范围:
|
Subscription |
| Name |
string |
服务实例名称。 |
TestName |
| EnableUserPrometheus |
boolean |
是否启用 Prometheus 监控。可能的值:
|
true |
| Components |
string |
云市场额外计费项。 |
{"TiKVServerCount":"3","package_version":"yuncode5398300001","PDServerCount":"3","TiDBServerCount":"2"} |
| PredefinedParameterName |
string |
套餐名称。 |
套餐一 |
| MarketInstanceId |
string |
云市场实例 ID。 |
704***59 |
| ResourceGroupId |
string |
资源组 ID。 |
rg-bp67acfmxazb4p**** |
| BizStatus |
string |
服务实例的业务状态。可能的值:
|
Normal |
| GrafanaDashBoardUrl |
string |
grafana 大盘链接。 |
https://g.console.aliyun.com/d/xxxxxxxx-cn-mariadb/mysql-xxxxxx-xxxxxxxx-and-dashboard?orgId=355401&refresh=10s |
| SupportTrialToPrivate |
boolean |
是否支持试用转正式 |
|
| PolicyNames |
string |
||
| GrantedPermission |
object |
||
| OperationEndTime |
string |
||
| PolicyNames |
string |
示例
正常返回示例
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"
],
"UpgradableServiceInfos": [
{
"Version": "draft",
"VersionName": "20241112"
}
],
"ServiceProductUrl": "https://service-info-private.oss-cn-hangzhou.aliyuncs.com",
"ServiceDocUrl": "http://example.com",
"OperationMetadata": "{\"SupportBackup\":false,\"PrometheusConfigMap\":{},\"ModifyParametersConfig\":[{\"TemplateName\":\"国内版\",\"Operation\":[{\"Name\":\"套餐变配\",\"Description\":\"套餐变配\",\"Type\":\"Custom\",\"SupportPredefinedParameters\":true,\"EnableLogging\":false},{\"Name\":\"参数变配\",\"Description\":\"参数变配\",\"Type\":\"Custom\",\"SupportPredefinedParameters\":false,\"EnableLogging\":false,\"Parameters\":[\"DataDiskSize\"]}]}]}"
},
"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",
"SupportTrialToPrivate": true,
"PolicyNames": "",
"GrantedPermission": {
"OperationEndTime": "",
"PolicyNames": ""
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。