All Products
Search
Document Center

Cloud Config:GetIntegratedServiceStatus

Last Updated:Apr 12, 2024

Queries the status of a cloud service that is integrated with Cloud Config.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
config:GetIntegratedServiceStatusRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ServiceCodestringYes

The product code of the cloud product. Valid values:

cadt: Cloud Architecture Design Tool

cadt

For more information about common request parameters, see Common parameters.

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

2E396C84-8D50-5F95-97FA-C0367181BA8A
Databoolean

Indicates whether the product has been integrated. Valid values:

  • true
  • false
true
IntegratedTypesstring

The types of the integrated events. Separate multiple event types with commas (,). Valid values:

  • ConfigurationItemChangeNotification: resource change event
  • NonCompliantNotification: non-compliance event
NonCompliantNotification

Examples

Sample success responses

JSONformat

{
  "RequestId": "2E396C84-8D50-5F95-97FA-C0367181BA8A",
  "Data": true,
  "IntegratedTypes": "NonCompliantNotification"
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-11-06The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
    delete Error Codes: 503
Output ParametersThe response structure of the API has changed.