Checking Whether a Secret Can Be Shared

Function

This API is used to check whether the secret can be shared.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v2/internal/shared-resources/check

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Apig-Appcode	Yes	String	appCode. This API needs to be granted to RAM applications.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
resource_urns	Yes	Array of ResourceUrn objects	Standard URN format.

**Table 3** ResourceUrn
Parameter	Mandatory	Type	Description
urn	Yes	String	Definition Secret resource URN description. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
resource_infos	Array of ResourceInfos objects	Definition Resource verification result. Range N/A

**Table 5** ResourceInfos
Parameter	Type	Description
resource_urn	String	Definition Standard URN format. Range N/A
status	String	Definition Status of the resource checked by the cloud service Range valid: The check is passed. Resources can be shared via RAM. invalid: The check fails. Resources cannot be shared via RAM.
status_message	String	Definition If status is invalid, you must enter the failure cause. Range N/A

Example Requests

Check whether the 9c46281e-6d9f-48fe-9994-c7914f313e91 and 9c46281e-6d9f-48fe-9994-c7914f314798 resources can be shared.

{
  "resource_urns" : [ {
    "urn" : "csms::3bab8e245e854f68af5967c00dd43127:secret:9c46281e-6d9f-48fe-9994-c7914f313e91"
  }, {
    "urn" : "csms::3bab8e245e854f68af5967c00dd43127:secret:9c46281e-6d9f-48fe-9994-c7914f314798"
  } ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "resource_infos" : [ {
    "resource_urn" : "csms::3bab8e245e854f68af5967c00dd43127:secret:9c46281e-6d9f-48fe-9994-c7914f313e91",
    "status" : "valid",
    "status_message" : ""
  }, {
    "resource_urn" : "csms::3bab8e245e854f68af5967c00dd43127:secret:9c46281e-6d9f-48fe-9994-c7914f314798",
    "status" : "invalid",
    "status_message" : "The specified resource could not be found in your account."
  } ]
}