GetServiceStatus - 获取云身份中心服务启用状态--云身份中心-火山引擎

文档中心

导航

GetServiceStatus - 获取云身份中心服务启用状态

最近更新时间：2025.03.21 11:09:18首次发布时间：2025.03.21 11:09:18

获取云身份中心服务启用状态

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetServiceStatus	要执行的操作，取值：GetServiceStatus。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Instances	Array of Object	[ { "InstanceID": "e", "Status": "1Bhs8", "CreatedTime": "3VsIwPef", "InstanceName": "9EjiU", "Region": "o9I" } ]	实例列表
PrerequisiteCheckResult	String	Success/Failed	服务开启条件检查结果

请求示例

POST /?Action=GetServiceStatus&Version=2023-01-01 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250309T122819Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250309/cn-beijing/cloudidentity/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250309202824137175137089117139",
    "Action": "GetServiceStatus",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {
    "Instances": [
      {
        "InstanceID": "e",
        "Status": "1Bhs8",
        "CreatedTime": "3VsIwPef",
        "InstanceName": "9EjiU",
        "Region": "o9I"
      }
    ],
    "PrerequisiteCheckResult": "Success/Failed"
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	PermissionError	No permission to perform action[%s] on resource %s	没有接口权限
400	ParamMissing	Missing parameter %v	参数缺省
400	ServiceStatusException	Can not perform action[%s] when service is %s	企业身份中心实例不可用
400	InvalidParam	The parameter %v[%v] is invalid	无效参数
400	ConcurrentException	Concurrent request exception	存在请求并发冲突
400	ParamIncludeSensitiveWord	The parameter %v Include sensitive Word	参数 %s 存在敏感词
500	InternalError	Unknown internal error: %v	服务内部错误