文档

GetInstance - 查询单个EIAM实例

更新时间:

查询一个EIAM实例的详细信息。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A
Instanceobject

实例信息。

InstanceIdstring

实例 ID。

idaas_abt3pfwojojcq323si6g5xxxxx
CreateTimelong

实例创建时间,Unix 时间戳格式,单位为毫秒。

1550115455000
Statusstring

实例状态,取值可选范围:

  • creating:创建中。
  • running:运行中。
running
Descriptionstring

实例描述信息。

线上环境使用
DefaultEndpointobject

实例默认域名,不再维护,请使用 DomainConfig 相关字段或参考查询域名列表接口。

Endpointstring

实例域名地址。

example-xxx.aliyunidaas.com
Statusstring

实例域名状态,取值可选范围:

  • resolved:已解析。
  • unresolved:未解析。
resolved
EgressAddressesarray

实例出口公网地址段。如在 AD 账户同步中,EIAM 实例会通过如下公网地址段访问您的 AD 服务。

string

实例出口公网地址。

出口公网地址,具体以接口实际返回为准。 示例:203.0.XX.XX/27
DomainConfigobject

实例域名相关配置信息。

InitDomainAutoRedirectStatusstring

初始化域名自动跳转状态,取值可选范围:

  • enabled:开启。

  • disabled:关闭。

disabled
DefaultDomainstring

实例默认域名。

login.example.com
InitDomainstring

实例初始化域名。

rx72nxxx.example.com

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Instance": {
    "InstanceId": "idaas_abt3pfwojojcq323si6g5xxxxx",
    "CreateTime": 1550115455000,
    "Status": "running",
    "Description": "线上环境使用",
    "DefaultEndpoint": {
      "Endpoint": "example-xxx.aliyunidaas.com\n",
      "Status": "resolved"
    },
    "EgressAddresses": [
      "出口公网地址,具体以接口实际返回为准。\n示例:203.0.XX.XX/27"
    ],
    "DomainConfig": {
      "InitDomainAutoRedirectStatus": "disabled",
      "DefaultDomain": "login.example.com",
      "InitDomain": "rx72nxxx.example.com"
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈